0% found this document useful (0 votes)
148 views45 pages

Kubernetes Ri Rke2-Sles Color en

The document provides an overview of deploying Rancher Kubernetes Engine Government on SUSE Linux Enterprise Server. It discusses the business benefits of using RKE2 for increased reliability, improved security, and standardized automation. It also describes the components involved and provides deployment instructions.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
148 views45 pages

Kubernetes Ri Rke2-Sles Color en

The document provides an overview of deploying Rancher Kubernetes Engine Government on SUSE Linux Enterprise Server. It discusses the business benefits of using RKE2 for increased reliability, improved security, and standardized automation. It also describes the components involved and provides deployment instructions.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 45

SUSE Linux Enterprise Server 15 SP3, Rancher

Kubernetes Engine Government 1.20.14

Introductory Deployment
of Rancher Kubernetes
Engine Government
Introductory Deployment of Rancher Kubernetes Engine Government: Refer-
ence Implementation
SUSE Linux Enterprise Server 15 SP3, Rancher Kubernetes Engine Government 1.20.14

The purpose of this document is to provide an overview and procedure of imple-


menting SUSE (R) offerings for Rancher Kubernetes Engine Government (RKE2), a
Kubernetes distribution that runs entirely within containers on bare-metal and vir-
tualized nodes. RKE2 solves the problem of installation complexity and the opera-
tion is both simplified and easily automated, while entirely accommodating the op-
erating system and platform it is running on. Also being a hardened, FIPS-enabled
version, it adopts a compliance-based approach toward security, targeting standard
risk management frameworks and best practices with the goal of stronger defense
for cloud-native applications.
Disclaimer: Documents published as part of the series SUSE Technical Reference
Documentation have been contributed voluntarily by SUSE employees and third
parties. They are meant to serve as examples of how particular actions can be per-
formed. They have been compiled with utmost attention to detail. However, this
does not guarantee complete accuracy. SUSE cannot verify that actions described in
these documents do what is claimed or whether actions described have unintended
consequences. SUSE LLC, its affiliates, the authors, and the translators may not be
held liable for possible errors or the consequences thereof.

Publication Date: 2022-03-28

SUSE LLC
1800 South Novell Place
Provo, UT 84606
USA
https://documentation.suse.com
Contents

1 Introduction 1
1.1 Motivation 1

1.2 Scope 2

1.3 Audience 2

2 Business aspect 3
2.1 Business problem 3

2.2 Business value 4

3 Architectural overview 6
3.1 Solution architecture 6

4 Component model 8
4.1 Component overview 8

4.2 Software - Rancher Kubernetes Engine Government 8

4.3 Software - SUSE Linux Enterprise Server 11

4.4 Compute Platform 11

5 Deployment 13
5.1 Deployment overview 13

5.2 Compute Platform 13

5.3 SUSE Linux Enterprise Server 14

5.4 Rancher Kubernetes Engine Government 16

iii Introductory Deployment of Rancher Kubernetes Engine Government


6 Summary 23

7 References 24

8 Glossary 26

9 Appendix 29
9.1 Compute platform bill of materials 29

9.2 Software bill of materials 29

9.3 Documentation configuration / attributes 31

10 Legal Notice 32

11 GNU Free Documentation License 33

iv Introductory Deployment of Rancher Kubernetes Engine Government


1 Introduction

On the digital transformation journey to a full cloud-native landscape, the use of microservices
becomes the main approach with the dominant technology for such container orchestration be-
ing Kubernetes.1 With its large community of developers and abundant features and capabili-
ties, Kubernetes has become the de-facto standard and is included across most container-as-a-
service platforms. With all of these technologies in place, both developer and operation teams
can effectively deploy, manage and deliver functionality to their end users in a resilient and
agile manner.

1.1 Motivation
Once on such a digital transformation journey, also relevant to focus on areas like:

Workload(s)
Determine how to manage and launch internally developed containerized, microservice
workloads

Kubernetes
As developers and organizations continue their journey from simple, containerized mi-
croservices toward having these workloads orchestrated and deployed where ever they
need, being able to install, monitor and use such Kubernetes infrastructures is a core need.
Such deployments, being Cloud Native Computing Foundation (CNCF2) conformant and
certified3 are essential for both development and production workloads.

With core focus on security and compliance, Rancher Kubernetes Engine Government
inherits close alignment with upstream Kubernetes and provide usability, ease-of-
operations, and deployment model for core use cases.

Compute Platform(s)
To optimize availability, performance, scalability and integrity, assess current system or
hosting platforms

1 https://kubernetes.io/

2 https://www.cncf.io/

3 https://www.cncf.io/certification/software-conformance

1 Motivation SUSE Linux Enterp…


1.2 Scope
The scope of this document is to provide a general reference implementation of Rancher Kuber-
netes Engine Government. This can be done in a variety of scenarios to create an enterprise
Kubernetes cluster deployment anywhere to provide a very secure environment.

1.3 Audience
This document is intended for IT decision makers, architects, system administrators and tech-
nicians who are implementing a flexible, software-defined Kubernetes platform. One should
still be familiar with the traditional IT infrastructure pillars — networking, computing and stor-
age — along with the local use cases for sizing, scaling and limitations within each pillars' en-
vironments.

2 Scope SUSE Linux Enterp…


2 Business aspect
Agility is driving developers toward more cloud-native methodologies that focus on microser-
vices architectures and streamlined workflows. Container technologies, like Kubernetes, embody
this agile approach and help enable cloud-native transformation.
By unifying IT operations with Kubernetes, organizations realize key benefits like increased
reliability, improved security and greater efficiencies with standardized automation. Therefore,
Kubernetes infrastructure platforms are adopted by enterprises to deliver:

Cluster Operations
Improved Production and DevOps efficiencies with simplified cluster usage and robust
operations

Security Policy & User Management


Consistent security policy enforcement plus advanced user management on any Kubernetes
infrastructure

Access to Shared Tools & Services


A high level of reliability with easy, consistent access to a broad set of tools and services

2.1 Business problem


Many organizations are deploying Kubernetes clusters everywhere — in the cloud, on-premises,
and at the edge — to unify IT operations. Such organizations can realize dramatic benefits, in-
cluding:

Consistently deliver a high level of reliability on any infrastructure

Improve DevOps efficiency with standardized automation

Ensure enforcement of security policies on any infrastructure

However, simply relying on upstream Kubernetes alone can introduce extra overhead and risk
because Kubernetes clusters are typically deployed:

Without central visibility

Without consistent security policies

And must be managed independently

3 Business problem SUSE Linux Enterp…


Deploying a scalable kubernetes infrastructure requires consideration of a larger ecosystem,
encompassing many software and infrastructure components and providers. Further, the ability
to continually address the needs and concerns of:

Developers
For those who focus on writing code to build their apps securely using a preferred work-
flow, providing a simple, push-button deployment mechanism of their containerized work-
loads where needed.

IT Operators
General infrastructure requirements still rely upon traditional IT pillars are for the stacked,
underlying infrastructure. Ease of deployment, availability, scalability, resiliency, perfor-
mance, security and integrity are still core concerns to be addressed for administrative
control and observability.

2.2 Business value


With Rancher Kubernetes Engine Government, the operation of Kubernetes is easily automated
and entirely independent of the operating system and platform running. Using a supported ver-
sion of the container runtime engine, one can deploy and run Kubernetes with Rancher Kuber-
netes Engine Government. It builds a cluster from a single command in a few minutes, and its
declarative configuration makes Kubernetes upgrades atomic and safe.
By allowing operation teams to focus on infrastructure and developers to deploy code the way
they want too, SUSE and the Rancher offerings helps bring products to market faster and accel-
erate an organization’s digital transformation.
SUSE Rancher is a fundamental part of the complete software stack for teams adopting contain-
ers. It provides DevOps teams with integrated tools for running containerized workloads while
also addressing the operational and security challenges of managing multiple Kubernetes clus-
ters across any targetedd infrastructure.

Developers
SUSE Rancher makes it easy to securely deploy containerized applications no matter where
the Kubernetes infrastructure runs -– in the cloud, on-premises, or at the edge. Using Helm
or the App Catalog to deploy and manage applications across any or all these environments,
ensuring multi-cluster consistency with a single deployment process.

IT Operators

4 Business value SUSE Linux Enterp…


SUSE Rancher not only deploys and manages production-grade Kubernetes clusters from
datacenter to cloud to the edge, it also unites them with centralized authentication, access
control and observability. Further, it streamlines cluster deployment on bare metal or vir-
tual machines and maintains them using defined security policies.

5 Business value SUSE Linux Enterp…


3 Architectural overview
This section outlines the core elements of the Rancher Kubernetes Engine Government solution,
along with the suggested target platforms and components.

3.1 Solution architecture


The figure below illustrates the high-level architecture overview of Kubernetes components on
instances like Rancher Kubernetes Engine Government:

Kubernetes cluster
API server
api

Cloud controller
c-m
c-m c-c-m manager
c-c-m
c-m c-c-m (optional) c-c-m

Controller
manager c-m

etcd
api
Node Node (persistence store)
api Node etcd

api

kubelet
kubelet

kubelet kubelet kubelet kube-proxy


etcd k-proxy

sched
sched
sched

Scheduler
sched

Control Plane k-proxy k-proxy k-proxy


Control plane

Node

FIGURE 3.1: ARCHITECTURE OVERVIEW - RANCHER KUBERNETES ENGINE GOVERNMENT

A Kubernetes cluster consists of a set of nodes machines, called workers or agents, that host and
run containerized applications in Pods. Every cluster has at least one worker node. The control
plane manages the worker nodes and the Pods in the cluster. The provider API is a generic
element that allows external interaction with the Kubernetes cluster.

Control Plane Components


The control plane’s components make global decisions about the cluster (for example,
scheduling), as well as detecting and responding to cluster events.

kube-apiserver

The API server is a component of the Kubernetes control plane that exposes the
Kubernetes API

etcd

6 Solution architecture SUSE Linux Enterp…


Consistent and highly-available key value store used as Kubernetes' backing
store for all cluster data.

kube-scheduler

Control plane component that watches for newly created Pods with no assigned
node, and selects a node for them to run on.

kube-controller-manager

Control plane component that runs controller processes.

Node Components
Node components run on every node, maintaining running pods and providing the Kuber-
netes runtime environment.

kubelet

An agent that runs on each node in the cluster. It makes sure that containers
are running in a Pod.

kube-proxy

A network proxy that runs on each node in your cluster, implementing part of
the Kubernetes Service concept.

While all Rancher Kubernetes Engine Government roles can be installed on a single system,
for the best availability, performance and security, the recommended deployment of a Rancher
Kubernetes Engine Government cluster is a pair of nodes for the control plane role, at least three
etcd role-based nodes and three or more worker nodes.

Note
Regardless of the deployment instance, Rancher Kubernetes Engine Government could
always be deployed by SUSE Rancher or imported as a managed, downstream cluster.

7 Solution architecture SUSE Linux Enterp…


4 Component model

This section describes the various components being used to create a Rancher Kubernetes Engine
Government solution deployment, in the perspective of top to bottom ordering. When complet-
ed, the Rancher Kubernetes Engine Government instance can be used as the application infra-
structure for cloud-native workloads and can be imported into SUSE Rancher for management.

4.1 Component overview


By using:

Kubernetes Platform - Rancher Kubernetes Engine Government

Operating System - SUSE Linux Enterprise Server

Compute Platform

you can create the necessary infrastructure and services. Further details for these components
are described in the following sections.

4.2 Software - Rancher Kubernetes Engine


Government
Rancher Kubernetes Engine Government also known as RKE2, is Rancher’s next-generation Ku-
bernetes distribution. It is a fully conformant Kubernetes distribution that focuses on security
and compliance within the U.S. Federal Government sector. It solves the common frustration of
installation complexity with Kubernetes by removing most host dependencies and presenting a
stable path for deployment, upgrades, and rollbacks.
To meet these goals, Rancher Kubernetes Engine Government does the following:

launches control plane components as static pods, managed by the kubelet. The embedded
container runtime is containerd.

provides defaults and configuration options that allow clusters to pass the CIS Kubernetes
Benchmark v1.5 or v1.6 with minimal operator intervention

8 Component overview SUSE Linux Enterp…


enables FIPS 140-2 compliance

regularly scans components for CVEs using trivy in our build pipeline

With Rancher Kubernetes Engine Government we take lessons learned from developing and
maintaining our lightweight Kubernetes distribution, K3s, and apply them to build an enter-
prise-ready distribution with K3s ease-of-use. What this means is that Rancher Kubernetes En-
gine Government is, at its simplest, a single binary to be installed and configured on all nodes
expected to participate in the Kubernetes cluster. When started, Rancher Kubernetes Engine
Government is then able to bootstrap and supervise role-appropriate agents per node while
sourcing needed content from the network.
The fundamental roles for the nodes and core functionality of Rancher Kubernetes Engine Gov-
ernment are represented in the following figure:

FIGURE 4.1: COMPONENT OVERVIEW - RANCHER KUBERNETES ENGINE GOVERNMENT

Rancher Kubernetes Engine Government brings together several open source technologies to
make this all work:

K3s - Helm Controller (https://github.com/k3s-io/helm-controller)

Kubernetes

API Server

Controller Manager

Kubelet

Scheduler

Proxy

etcd

9 Software - Rancher Kubernetes Engine Government SUSE Linux Enterp…


Container Runtime - runc, containerd/cri

CoreDNS

NGINX Ingress Controller

Metrics Server

Helm

All of these, except the NGINX Ingress Controller, are compiled and statically linked with 1
While all Rancher Kubernetes Engine Government roles can be installed on a single system,
for the best availability, performance and security, the recommended deployment of a Rancher
Kubernetes Engine Government cluster is a pair of nodes for the control plane role, at least three
etcd role-based nodes and three or more worker nodes.
Rancher Kubernetes Engine Government can run as a complete cluster on a single node or can
be expanded into a multi-node cluster. Besides the core Kubernetes components, these are also
configurable and included:

Multiple Kubernetes versions

CoreDNS, Metrics, Ingress controller

CNI: Canal (Calico & Flannel), Cilium or Calico

Fleet Agent : for GitOps deployment of cloud-native applications

All of these components are configurable and can be swapped out for your implementation of
choice. With these included components, you get a fully functional and CNCF-conformant cluster
so you can start running apps right away.

Tip
Learn more information about Rancher Kubernetes Engine Government at https://doc-
s.rke2.io/ .

While all Rancher Kubernetes Engine Government roles can be installed on a single system, a
multi-node cluster, is a more production-like approach and will be described in the deployment
section.

1 https://github.com/golang/go/tree/dev.boringcrypto/misc/boring

10 Software - Rancher Kubernetes Engine Government SUSE Linux Enterp…


Tip
To improve availability, performance and security, the recommended deployment of a
Rancher Kubernetes Engine Government cluster is a pair of nodes for the control plane
role, at least three etcd role-based nodes and three or more worker nodes.

4.3 Software - SUSE Linux Enterprise Server


SUSE Linux Enterprise Server (SLES (https://www.suse.com/products/server/) ) is an adaptable
and easy-to-manage platform that allows developers and administrators to deploy business-crit-
ical workloads on-premises, in the cloud and at the edge. It is a Linux operating system that is
adaptable to any environment – optimized for performance, security and reliability. As a mul-
timodal operating system that paves the way for IT transformation in the software-defined era,
this simplifies multimodal IT, makes traditional IT infrastructure efficient and provides an en-
gaging platform for developers. As a result, one can easily deploy and transition business-critical
workloads across on-premises and public cloud environments.
Designed for interoperability, SUSE Linux Enterprise Server integrates into classical Unix and
Windows environments, supports open standard interfaces for systems management, and has
been certified for IPv6 compatibility. This modular, general purpose operating system runs on
four processor architectures and is available with optional extensions that provide advanced
capabilities for tasks such as real time computing and high availability clustering. SUSE Linux
Enterprise Server is optimized to run as a high performing guest on leading hypervisors and
supports an unlimited number of virtual machines per physical system with a single subscription.
This makes it the perfect guest operating system for virtual computing.

4.4 Compute Platform


Leveraging the enterprise grade functionality of the operating system mentioned in the previous
section, many compute platforms can be the foundation of the deployment:

Virtual machines on supported hypervisors or hosted on cloud service providers

Physical, baremetal or single-board computers, either on-premises or hosted by cloud ser-


vice providers

11 Software - SUSE Linux Enterprise Server SUSE Linux Enterp…


Note
To complete self-testing of hardware with SUSE YES Certified Process (https://
www.suse.com/partners/ihv/yes/yes-certified-process) , you can download and install the
respective SUSE operating system support-pack version of SUSE Linux Enterprise Server
and the YES test suite. Then run the tests per the instructions in the test kit, fixing any
problems encountered and when corrected, re-run all tests to obtain clean test results.
Submit the test results into the SUSE Bulletin System (SBS) for audit, review and valida-
tion.

Tip
Certified systems and hypervisors can be verified via SUSE YES Certified Bulletins (https://
www.suse.com/yessearch/) and then can be leveraged as supported nodes for this de-
ployment, as long as the certification refers to the respective version of the underlying
SUSE operating system required.

12 Compute Platform SUSE Linux Enterp…


5 Deployment

This section describes the process steps for the deployment of the Rancher Kubernetes Engine
Government solution. It describes the process steps to deploy each of the component layers start-
ing as a base functional proof-of-concept, having considerations on migration toward production,
providing scaling guidance that is needed to create the solution.

5.1 Deployment overview


The deployment stack is represented in the following figure:

FIGURE 5.1: DEPLOYMENT STACK - RANCHER KUBERNETES ENGINE GOVERNMENT

and details are covered for each layer in the following sections.

Note
The following section’s content is ordered and described from the bottom layer up to the
top.

5.2 Compute Platform


Preparation(s)

13 Deployment overview SUSE Linux Enterp…


For each node used in the deployment:

Validate the necessary CPU, memory, disk capacity, and network interconnect quan-
tity and type are present for each node and its intended role. Refer to the recom-
mended CPU/Memory/Disk/Networking requirements as noted in the Rancher Kuber-
netes Engine Government Hardware Requirements (https://docs.rke2.io/install/require-
ments/) .

Further suggestions

Disk : Use a pair of local, direct attached, mirrored disk drives is present on
each node (SSDs are preferred); these will become the target for the operating
system installation.

Network : Prepare an IP addressing scheme and optionally create both a public


and private network, along with the respective subnets and desired VLAN des-
ignations for the target environment.

Baseboard Management Controller : If present, consider using a distinct


management network for controlled access.

Boot Settings : BIOS/uEFI reset to defaults for a known baseline, consistent state
or perhaps with desired, localized values.

Firmware : Use consistent and up-to-date versions for BIOS/uEFI/device


rmware to reduce potential troubleshooting issues later

5.3 SUSE Linux Enterprise Server


As the base software layer, use an enterprise-grade Linux operating system. For example, SUSE
Linux Enterprise Server.

Preparation(s)
To meet the solution stack prerequisites and requirements, SUSE operating system offer-
ings, like SUSE Linux Enterprise Server (https://www.suse.com/products/server/) can be
used.

14 SUSE Linux Enterprise Server SUSE Linux Enterp…


1. Ensure these services are in place and configured for this node to use:

Domain Name Service (DNS) - an external network-accessible service to map


IP Addresses to host names

Network Time Protocol (NTP) - an external network-accessible service to obtain


and synchronize system times to aid in time stamp consistency

Software Update Service - access to a network-based repository for software


update packages. This can be accessed directly from each node via registration
to

the general, internet-based SUSE Customer Center (https://scc.suse.com)


(SCC) or

an organization’s SUSE Manager (https://www.suse.com/products/suse-


manager/) infrastructure or

a local server running an instance of Repository Mirror-


ing Tool (https://documentation.suse.com/sles/15-SP3/single-html/SLES-
rmt/#book-rmt) (RMT)

Note
During the node’s installation, it can be pointed to the respective
update service. This can also be accomplished post-installation with
the command line tool named SUSEConnect (https://www.suse.com/
support/kb/doc/?id=000018564) .

Deployment Process
On the compute platform node, install the noted SUSE operating system, by following
these steps:

1. Download the SUSE Linux Enterprise Server (https://www.suse.com/download/sles/)


product (either for the ISO or Virtual Machine image)

15 SUSE Linux Enterprise Server SUSE Linux Enterp…


Identify the appropriate, supported version of SUSE Linux Enterprise Server
by reviewing the support matrix for SUSE Rancher (https://www.suse.com/suse-
rancher/support-matrix/all-supported-versions/) versions Web page.

2. The installation process is described and can be performed with default values by fol-
lowing steps from the product documentation, see Installation Quick Start (https://doc-
umentation.suse.com/sles/15-SP3/single-html/SLES-installation/#article-installation)

Tip
Adjust both the password and the local network addressing setup to comply
with local environment guidelines and requirements.

Deployment Consideration(s)
To further optimize deployment factors, leverage the following practices:

Automation

To reduce user intervention, unattended deployments of SUSE Linux Enterprise


Server can be automated

for ISO-based installations, by referring to the AutoY-


aST Guide (https://documentation.suse.com/sles/15-SP3/single-html/SLES-
autoyast/#book-autoyast)

5.4 Rancher Kubernetes Engine Government


Preparation(s)

1. Identify the appropriate, desired version of the Rancher Kubernetes Engine Govern-
ment (for example vX.YY.ZZ+rke2rV) by reviewing

16 Rancher Kubernetes Engine Government SUSE Linux Enterp…


the "Supported Rancher Kubernetes Engine Government Versions" associat-
ed with the respective SUSE Rancher (https://www.suse.com/suse-rancher/sup-
port-matrix/all-supported-versions/) version from "Rancher Kubernetes Engine
Government Downstream Clusters" section, or

the "Releases" on the Download (https://github.com/rancher/rke2/) Web page.

2. For Rancher Kubernetes Engine Government versions 1.21 and higher, if the host
kernel supports AppArmor, the AppArmor tools (usually available via the "appar-
mor-parser" package) must also be present prior to installing Rancher Kubernetes
Engine Government.

On the SUSE Linux Enterprise Server node, install this required package

zypper install apparmor-parser

3. For the underlying operating system firewall service, either

enable and configure the necessary inbound ports (https://rancher.com/docs/


rke/latest/en/os/#ports) or

stop and completely disable the firewall service.

Deployment Process
Perform the following steps to install the rst Rancher Kubernetes Engine Government
server on one of the nodes to be used for the Kubernetes control plane

1. Set the following variable with the noted version of Rancher Kubernetes Engine Gov-
ernment, as found during the preparation steps.

RKE2_VERSION=""

2. Install the appropriate version of Rancher Kubernetes Engine Government:

Download the installer script:

curl -sfL https://get.rke2.io | \

17 Rancher Kubernetes Engine Government SUSE Linux Enterp…


INSTALL_RKE2_VERSION=${RKE2_VERSION} sh -

Set the following variable with the URL that will be used to access the SUSE
Rancher server. This may be based on one or more DNS entries, a reverse-proxy
server, or a load balancer:

RKE2_subjectAltName=

Create the RKE2 config.yaml le:

mkdir -p /etc/rancher/rke2/
cat <<EOF> /etc/rancher/rke2/config.yaml
write-kubeconfig-mode: "0644"
tls-san:
- "${RKE2_subjectAltName}"
EOF

3. Start and enable the RKE2 service, which will begin installing the required Kuber-
netes components:

systemctl enable --now rke2-server.service

Include the Rancher Kubernetes Engine Government binary directories in this


user’s path:

echo "PATH=${PATH}:/opt/rke2/bin:/var/lib/rancher/rke2/bin/" >> ~/.bashrc


source ~/.bashrc

Monitor the progress of the installation:

export KUBECONFIG=/etc/rancher/rke2/rke2.yaml
watch -c "kubectl get deployments -A"

Note
For the rst two to three minutes of the installation, the initial output will
include the error phrase "The connection to the server 127.0.0.1:6443
was refused - did you specify the right host or port?". As Kubernetes ser-
vices get started this will be replace with "No resources found". About

18 Rancher Kubernetes Engine Government SUSE Linux Enterp…


four minutes after beginning the installation, the output will begin show-
ing the deployments being created, and after six to seven minutes the
installation should be complete.

The Rancher Kubernetes Engine Government deployment is complete


when elements of all the deployments (coredns, ingress, and metrics-serv-
er) show at least "1" as "AVAILABLE"

Use Ctrl+c to exit the watch loop after all deployment pods are
running

Deployment Consideration(s)
To further optimize deployment factors, leverage the following practices:

Availability

A full high-availability Rancher Kubernetes Engine Government cluster is rec-


ommended for production workloads. The etcd key/value store (aka database)
requires an odd number of servers (aka master nodes) be allocated to the Ranch-
er Kubernetes Engine Government cluster. In this case, two additional con-
trol-plane servers should be added; for a total of three.

1. Deploy the same operating system on the new compute platform nodes

2. Log in to the rst server node and create a new config.yaml le for the
remaining two server nodes:

Set the following variables, as appropriate for this cluster

# Private IP preferred, if available


FIRST_SERVER_IP=""

# Private IP preferred, if available


SECOND_SERVER_IP=""

# Private IP preferred, if available


THIRD_SERVER_IP=""

# From the /var/lib/rancher/rke2/server/node-token file on the


first server
NODE_TOKEN=""

19 Rancher Kubernetes Engine Government SUSE Linux Enterp…


# Match the first of the first server (Hint: `kubectl get
nodes`)
RKE2_VERSION=""

Create the new config.yaml le:

echo "server: https://${FIRST_SERVER_IP}:9345" > config.yaml


echo "token: ${NODE_TOKEN}" >> config.yaml
cat /etc/rancher/rke2/config.yaml >> config.yaml

Tip
The next steps require using SCP and SSH. Setting up pass-
wordless SSH, and/or using ssh-agent , from the rst serv-
er node to the second and third nodes will make these steps
quicker and easier.

Copy the new config.yaml le to the remaining two server nodes:

scp config.yaml ${SECOND_SERVER_IP}:~/


scp config.yaml ${THIRD_SERVER_IP}:~/

Move the config.yaml le to the correct location in the le system:

ssh ${SECOND_SERVER_IP} << EOF


mkdir -p /etc/rancher/rke2/
cp ~/config.yaml /etc/rancher/rke2/config.yaml
cat /etc/rancher/rke2/config.yaml
EOF

ssh ${THIRD_SERVER_IP} << EOF


mkdir -p /etc/rancher/rke2/
cp ~/config.yaml /etc/rancher/rke2/config.yaml
cat /etc/rancher/rke2/config.yaml
EOF

Execute the following sets of commands on each of the remaining


control-plane nodes:

Install Rancher Kubernetes Engine Government

ssh ${SECOND_SERVER_IP} << EOF


curl -sfL https://get.rke2.io | \
INSTALL_RKE2_VERSION=${RKE2_VERSION} sh -

20 Rancher Kubernetes Engine Government SUSE Linux Enterp…


systemctl enable --now rke2-server.service
EOF

ssh ${THIRD_SERVER_IP} << EOF


curl -sfL https://get.rke2.io | \
INSTALL_RKE2_VERSION=${RKE2_VERSION} sh -
systemctl enable --now rke2-server.service
EOF

Monitor the progress of the new server nodes joining the Rancher
Kubernetes Engine Government cluster: watch -c "kubectl get
nodes"

It takes up to eight minutes for each node to join the cluster

A node has deployed correctly when its status is "Ready" and


it holds the roles of "control-plane,etcd,master"

Use Ctrl+c to exit the watch loop after all deployment pods
are running

Note
This can be changed to the normal Kubernetes default
by adding a taint to each server node. See the official
Kubernetes documentation for more information on how
to do that.

3. (Optional) In cases where agent nodes are desired, execute the following
sets of commands, using the same, "RKE2_VERSION", "FIRST_SERVER_IP"
and "NODE_TOKEN" variable settings as above, on each of the agent nodes
to add it to the Rancher Kubernetes Engine Government cluster:

curl -sfL https://get.rke2.io | \


INSTALL_RKE2_VERSION=${RKE2_VERSION} \
RKE2_URL=https://${FIRST_SERVER_IP}:6443 \
RKE2_TOKEN=${NODE_TOKEN} \
RKE2_KUBECONFIG_MODE="644" \

21 Rancher Kubernetes Engine Government SUSE Linux Enterp…


sh -

After this successful deployment of the Rancher Kubernetes Engine Government solution, review
the product documentation (https://docs.rke2.io/) for details on how to directly use this Ku-
bernetes cluster. Furthermore, by reviewing the SUSE Rancher product documentation (https://
rancher.com/docs/rancher/v2.5/en/) this solution can also be:

imported (refer to sub-section "Importing Existing Clusters"), then

managed (refer to sub-section "Cluster Administration") and

accessed (refer to sub-section "Cluster Access") to address orchestration of workloads, main-


taining security and many more functions are readily available.

22 Rancher Kubernetes Engine Government SUSE Linux Enterp…


6 Summary
Using components and offerings from SUSE (https://www.suse.com) and the Rancher portfolio
streamline the ability to quickly and effectively engage in a digital transformation, taking ad-
vantage of cloud-native resources and disciplines. Using such technology approaches lets you
deploy and leverage transformations of infrastructure into a durable, reliable enterprise-grade
environment.

Simplify
Simplify and optimize your existing IT environments

Using Rancher Kubernetes Engine Government enables you to simplify, maintain and
scale Kubernetes cluster deployments in a supportable fashion, with a primary focus
on security aspects as well.

Modernize
Bring applications and data into modern computing

With Rancher Kubernetes Engine Government, the digital transformation to con-


tainerized applications can benefit from the provided, production-quality application
infractructures for each of the respective user bases and to facilitate the actual work-
load deployments and resilient usage.

Accelerate
Accelerate business transformation through the power of open source software

Given the open source nature of Rancher Kubernetes Engine Government and the un-
derlying software components, you can simplify deployment with automation, main-
tain secure production instance and make significant IT savings as you scale orches-
trated microservice deployments anywhere you need to and for whatever use cases
are needed, in an agile and innovative way.

23 SUSE Linux Enterp…


7 References
WHITE PAPERS

A Buyer’s Guide to Enterprise Kubernetes Management Platforms - https://info.ranch-


er.com/enterprise-kubernetes-management-buyers-guide

How to Build an Enterprise Kubernetes Strategy - https://info.rancher.com/how-to-build-


enterprise-kubernetes-strategy

BOOKS

Kubernetes Management - https://info.rancher.com/kubernetes-management-for-dum-


mies-rancher-and-suse-0-0

TRAINING

SUSE - https://training.suse.com/

Rancher - https://rancher.com/training/

WEB SITES

SUSE - https://www.suse.com

SUSE Customer Center (SCC) - https://scc.suse.com

Products

SUSE Rancher - https://rancher.com/products/rancher/ (documentation


(https://rancher.com/docs/rancher/v2.5/en/) )

Rancher Kubernetes Engine (RKE) - https://rancher.com/products/rke/ (docu-


mentation (https://rancher.com/docs/rke/latest/en/) )

K3s - https://rancher.com/products/k3s/ (documentation (https://ranch-


er.com/docs/k3s/latest/en/) )

SUSE Linux Enterprise Micro (SLEMicro) - https://www.suse.com/products/mi-


cro/ (documentation (https://documentation.suse.com/sle-micro/5.0/) )

SUSE Linux Enterprise Server (SLES) - https://www.suse.com/products/server/


(documentation (https://documentation.suse.com/sles/15-SP3/) )

24 SUSE Linux Enterp…


SUSE Manager - https://www.suse.com/products/suse-manager/ (documenta-
tion (https://documentation.suse.com/suma/4.2/) )

SUSE Repository Mirroring Tool (RMT) - https://www.suse.com/products/serv-


er/ (documentation (https://documentation.suse.com/sles/15-SP3/single-html/
SLES-rmt/#book-rmt) )

Projects

Rancher Kubernetes Engine Government (RKE2) - https://github.com/ranch-


er/rke2 (documentation (https://docs.rke2.io/) )

25 SUSE Linux Enterp…


8 Glossary
Document Scope

Reference Implementation
A guide with the basic steps to deploy the highlighted components of the SUSE port-
folio, including generalized pointers to other layers and elements. This is considered
an introductory approach and a basis for other tested variations.
1
Reference Architectures
A guide with the general steps to deploy and validate the structured solution compo-
nents from both the SUSE and partner portfolios. This provides a shareable template
of consistency for consumers to leverage for similar production ready solutions, in-
cluding design considerations, implementation suggestions and best practices.

Best Practice
Information that can overlap both the SUSE and partner space. It can either be pro-
vided as a stand-alone guide that provides reliable technical information not covered
in other product documentation, based on real-life installation and implementation
experiences from subject matter experts or complementary, embedded sections with-
in any of the above documentation types describing considerations and possible steps
forward.

Factor(s)
2
Automation
Infrastructure automation enables speed through faster execution when configuring
the infrastructure and aims at providing visibility to help other teams across the en-
terprise work quickly and more efficiently. Automation removes the risk associated
with human error, like manual misconfiguration; removing this can decrease down-
time and increase reliability. These outcomes and attributes help the enterprise move
toward implementing a culture of DevOps, the combined working of development
and operations.
3
Availability

1 link: Reference Architecture (https://en.wikipedia.org/wiki/Reference_architecture)

2 link: Infrastructure-as-Code (https://en.wikipedia.org/wiki/Infrastructure_as_code)

3 link: Availability (https://en.wikipedia.org/wiki/Availability)

26 SUSE Linux Enterp…


The probability that an item operates satisfactorily, without failure or downtime, un-
der stated conditions as a function of its reliability, redundancy and maintainability
attributes. Some major objectives to achieve a desired service level objectives are:

Preventing or reducing the likelihood and frequency of failures via design de-
cisions within the allowed cost of ownership

Correcting or coping with possible component failures via resiliency, automated


failover and disaster-recovery processes

Estimating and analyzing current conditions to prevent unexpected failures via


predictive maintenance

4
Integrity
Integrity is the maintenance of, and the insurance of the accuracy and consistency of
a specific element over its entire lifecycle. Both physical and logical aspects must be
managed to ensure stability, performance, re-usability and maintainability.

5
Security
Security is about ensuring freedom from or resilience against potential harm, includ-
ing protection from destructive or hostile forces. To minimize risks, one mus manage
governance to avoid tampering, maintain access controls to prevent unauthorized
usage and integrate layers of defense, reporting and recovery tactics.

Deployment Flavor(s)

6
Proof-of-Concept
A partial or nearly complete prototype constructed to demonstrate functionality and
feasibility for verifying specific aspects or concepts under consideration. This is often
a starting point when evaluating a new, transitional technology. Sometimes it starts
as a Minimum Viable Product (MVP7) that has just enough features to satisfy an
initial set of requests. After such insights and feedback are obtained and potentially
addressed, redeployments may be used to iteratively branch into other realms or to
incorporate other known working functionality.

4 link: Data Integrity (https://en.wikipedia.org/wiki/Data_integrity)

5 link: Security (https://en.wikipedia.org/wiki/Security)

6 link: Proof of Concept (https://en.wikipedia.org/wiki/Proof_of_concept)

7 link: Minimum Viable Product (https://en.wikipedia.org/wiki/Minimum_viable_product)

27 SUSE Linux Enterp…


Production
A deployed environment that target customers or users can interact with and rely
upon to meet their needs, plus be operationally sustainable in terms of resource usage
and economic constraints.

Scaling
The flexibility of a system environment to either vertically scale-up, horizontally
scale-out or conversely scale-down by adding or subtracting resources as needed. At-
tributes like capacity and performance are often the primary requirements to address,
while still maintaining functional consistency and reliability.

28 SUSE Linux Enterp…


9 Appendix

The following sections provide a bill of materials listing for the respective component layer(s)
of the described deployment.

9.1 Compute platform bill of materials


Sample set of computing platform models, components and resources.

Role Qty SKU Component Notes

System 1-3 n/a Virtual Machine, Configuration

Single Board Com-


puter (SBC) or

Industry Standard
Server

9.2 Software bill of materials


Sample set of software, support and services.

Role Qty SKU Component Notes

Operating Sys- 1-3 874-006875 SUSE Linux Enterprise Configuration:


tem Server,
per node
(up to
2 sock-

29 Compute platform bill of materials SUSE Linux Enterp…


Role Qty SKU Component Notes
x86_64, ets, stack-
able) or 2
Priority Subscrip-
VMs
tion,

1 Year

Kubernetes 1 R-0001-PS1 SUSE Rancher, Configuration:


Management
x86-64, per de-
ployed
Priority Subscrip-
instance
tion,

1 Year

Rancher Man- 2 R-0004-PS1 Rancher 10 Nodes Configuration:


agement
x86-64 or requires
aarch64, priori-
ty server
Priority Subscrip-
subscrip-
tion,
tion
1 Year,

Consulting and 1 R-0001-QSO Rancher Quick Start,


Training
Go Live Services

Note
For the software components, other support term durations are also available.

30 Software bill of materials SUSE Linux Enterp…


9.3 Documentation configuration / attributes
This document was built using the following AsciiDoc (https://github.com/asciidoc/asciidoc) and
DocBook Authoring and Publishing Suite (DAPS (https://github.com/openSUSE/daps) ) attribut-
es:

Appendix=1 ArchOv=1 Automation=1 Availability=1 BP=1 BPBV=1 CompMod=1 DepConsiderations=1


Deployment=1 FCTR=1 FLVR=1 GFDL=1 Glossary=1 HWComp=1 HWDepCfg=1 Integrity=1 LN=1
PoC=1 Production=1 RA=1 RI=1 References=1 Requirements=1 SWComp=1 SWDepCfg=1 Scaling=1
Security=1 docdate=2022-03-28 env-daps=1 focusRKE2=1 iK3s=1 iRKE1=1 iRKE2=1 iRMT=1
iRancher=1 iSLEMicro=1 iSLES=1 iSUMa=1 layerSLES=1

31 Documentation configuration / attributes SUSE Linux Enterp…


10 Legal Notice
Copyright © 2006–2022 SUSE LLC and contributors. All rights reserved.
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant
Section being this copyright notice and license. A copy of the license version 1.2 is included in
the section entitled "GNU Free Documentation License".
SUSE, the SUSE logo and YaST are registered trademarks of SUSE LLC in the United States and
other countries. For SUSE trademarks, see https://www.suse.com/company/legal/ .
Linux is a registered trademark of Linus Torvalds. All other names or trademarks mentioned in
this document may be trademarks or registered trademarks of their respective owners.
Documents published as part of the series SUSE Technical Reference Documentation have been
contributed voluntarily by SUSE employees and third parties. They are meant to serve as exam-
ples of how particular actions can be performed. They have been compiled with utmost attention
to detail. However, this does not guarantee complete accuracy. SUSE cannot verify that actions
described in these documents do what is claimed or whether actions described have unintended
consequences. SUSE LLC, its affiliates, the authors, and the translators may not be held liable
for possible errors or the consequences thereof.

32 SUSE Linux Enterp…


11 GNU Free Documentation License

Copyright © 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston,
MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful docu-
ment "free" in the sense of freedom: to assure everyone the effective freedom to copy and redis-
tribute it, with or without modifying it, either commercially or noncommercially. Secondarily,
this License preserves for the author and publisher a way to get credit for their work, while not
being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must
themselves be free in the same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free
software needs free documentation: a free program should come with manuals providing the
same freedoms that the software does. But this License is not limited to software manuals; it
can be used for any textual work, regardless of subject matter or whether it is published as a
printed book. We recommend this License principally for works whose purpose is instruction
or reference.

1. APPLICABILITY AND DEFINITIONS


This License applies to any manual or other work, in any medium, that contains a notice placed
by the copyright holder saying it can be distributed under the terms of this License. Such a
notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under
the conditions stated herein. The "Document", below, refers to any such manual or work. Any
member of the public is a licensee, and is addressed as "you". You accept the license if you copy,
modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion
of it, either copied verbatim, or with modifications and/or translated into another language.

33 0. PREAMBLE SUSE Linux Enterp…


A "Secondary Section" is a named appendix or a front-matter section of the Document that deals
exclusively with the relationship of the publishers or authors of the Document to the Document’s
overall subject (or to related matters) and contains nothing that could fall directly within that
overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section
may not explain any mathematics.) The relationship could be a matter of historical connection
with the subject or with related matters, or of legal, commercial, philosophical, ethical or po-
litical position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being
those of Invariant Sections, in the notice that says that the Document is released under this
License. If a section does not t the above definition of Secondary then it is not allowed to be
designated as Invariant. The Document may contain zero Invariant Sections. If the Document
does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-
Cover Texts, in the notice that says that the Document is released under this License. A Front-
Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format
whose specification is available to the general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of pixels) generic paint
programs or (for drawings) some widely available drawing editor, and that is suitable for input
to text formatters or for automatic translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent le format whose markup, or absence of
markup, has been arranged to thwart or discourage subsequent modification by readers is not
Transparent. An image format is not Transparent if used for any substantial amount of text. A
copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Tex-
info input format, LaTeX input format, SGML or XML using a publicly available DTD, and stan-
dard-conforming simple HTML, PostScript or PDF designed for human modification. Examples
of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary
formats that can be read and edited only by proprietary word processors, SGML or XML for
which the DTD and/or processing tools are not generally available, and the machine-generated
HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are
needed to hold, legibly, the material this License requires to appear in the title page. For works
in formats which do not have any title page as such, "Title Page" means the text near the most
prominent appearance of the work’s title, preceding the beginning of the body of the text.

34 1. APPLICABILITY AND DEFINITIONS SUSE Linux Enterp…


A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely
XYZ or contains XYZ in parentheses following text that translates XYZ in another language.
(Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements",
"Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you
modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this Li-
cense applies to the Document. These Warranty Disclaimers are considered to be included by
reference in this License, but only as regards disclaiming warranties: any other implication that
these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncom-
mercially, provided that this License, the copyright notices, and the license notice saying this
License applies to the Document are reproduced in all copies, and that you add no other condi-
tions whatsoever to those of this License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or distribute. However, you may
accept compensation in exchange for copies. If you distribute a large enough number of copies
you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display
copies.

3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the
Document, numbering more than 100, and the Document’s license notice requires Cover Texts,
you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-
Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also
clearly and legibly identify you as the publisher of these copies. The front cover must present the
full title with all words of the title equally prominent and visible. You may add other material
on the covers in addition. Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated as verbatim copying in
other respects.

35 2. VERBATIM COPYING SUSE Linux Enterp…


If the required texts for either cover are too voluminous to t legibly, you should put the rst
ones listed (as many as t reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must
either include a machine-readable Transparent copy along with each Opaque copy, or state in
or with each Opaque copy a computer-network location from which the general network-using
public has access to download using public-standard network protocols a complete Transparent
copy of the Document, free of added material. If you use the latter option, you must take rea-
sonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated location until at least one year
after the last time you distribute an Opaque copy (directly or through your agents or retailers)
of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before
redistributing any large number of copies, to give them a chance to provide you with an updated
version of the Document.

4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sec-
tions 2 and 3 above, provided that you release the Modified Version under precisely this License,
with the Modified Version filling the role of the Document, thus licensing distribution and mod-
ification of the Modified Version to whoever possesses a copy of it. In addition, you must do
these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document,
and from those of previous versions (which should, if there were any, be listed in the
History section of the Document). You may use the same title as a previous version if the
original publisher of that version gives permission.

B. List on the Title Page, as authors, one or more persons or entities responsible for authorship
of the modifications in the Modified Version, together with at least ve of the principal
authors of the Document (all of its principal authors, if it has fewer than ve), unless they
release you from this requirement.

C. State on the Title page the name of the publisher of the Modified Version, as the publisher.

D. Preserve all the copyright notices of the Document.

36 4. MODIFICATIONS SUSE Linux Enterp…


E. Add an appropriate copyright notice for your modifications adjacent to the other copyright
notices.

F. Include, immediately after the copyright notices, a license notice giving the public permis-
sion to use the Modified Version under the terms of this License, in the form shown in
the Addendum below.

G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts
given in the Document’s license notice.

H. Include an unaltered copy of this License.

I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at
least the title, year, new authors, and publisher of the Modified Version as given on the
Title Page. If there is no section Entitled "History" in the Document, create one stating the
title, year, authors, and publisher of the Document as given on its Title Page, then add an
item describing the Modified Version as stated in the previous sentence.

J. Preserve the network location, if any, given in the Document for public access to a Trans-
parent copy of the Document, and likewise the network locations given in the Document
for previous versions it was based on. These may be placed in the "History" section. You
may omit a network location for a work that was published at least four years before the
Document itself, or if the original publisher of the version it refers to gives permission.

K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the
section, and preserve in the section all the substance and tone of each of the contributor
acknowledgements and/or dedications given therein.

L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their
titles. Section numbers or the equivalent are not considered part of the section titles.

M. Delete any section Entitled "Endorsements". Such a section may not be included in the
Modified Version.

N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with
any Invariant Section.

O. Preserve any Warranty Disclaimers.

37 4. MODIFICATIONS SUSE Linux Enterp…


If the Modified Version includes new front-matter sections or appendices that qualify as Se-
condary Sections and contain no material copied from the Document, you may at your option
designate some or all of these sections as invariant. To do this, add their titles to the list of
Invariant Sections in the Modified Version’s license notice. These titles must be distinct from
any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements
of your Modified Version by various parties—for example, statements of peer review or that the
text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to ve words as a Front-Cover Text, and a passage of up to 25
words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only
one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through
arrangements made by) any one entity. If the Document already includes a cover text for the
same cover, previously added by you or by arrangement made by the same entity you are acting
on behalf of, you may not add another; but you may replace the old one, on explicit permission
from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use
their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the
terms defined in section 4 above for modified versions, provided that you include in the combi-
nation all of the Invariant Sections of all of the original documents, unmodified, and list them
all as Invariant Sections of your combined work in its license notice, and that you preserve all
their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant
Sections may be replaced with a single copy. If there are multiple Invariant Sections with the
same name but different contents, make the title of each such section unique by adding at the
end of it, in parentheses, the name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section titles in the list of Invariant
Sections in the license notice of the combined work.

38 5. COMBINING DOCUMENTS SUSE Linux Enterp…


In the combination, you must combine any sections Entitled "History" in the various original
documents, forming one section Entitled "History"; likewise combine any sections Entitled "Ac-
knowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled
"Endorsements".

6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under
this License, and replace the individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you follow the rules of this License
for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under
this License, provided you insert a copy of this License into the extracted document, and follow
this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS


A compilation of the Document or its derivatives with other separate and independent docu-
ments or works, in or on a volume of a storage or distribution medium, is called an "aggregate"
if the copyright resulting from the compilation is not used to limit the legal rights of the com-
pilation’s users beyond what the individual works permit. When the Document is included in
an aggregate, this License does not apply to the other works in the aggregate which are not
themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if
the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be
placed on covers that bracket the Document within the aggregate, or the electronic equivalent
of covers if the Document is in electronic form. Otherwise they must appear on printed covers
that bracket the whole aggregate.

8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Doc-
ument under the terms of section 4. Replacing Invariant Sections with translations requires spe-
cial permission from their copyright holders, but you may include translations of some or all

39 6. COLLECTIONS OF DOCUMENTS SUSE Linux Enterp…


Invariant Sections in addition to the original versions of these Invariant Sections. You may in-
clude a translation of this License, and all the license notices in the Document, and any War-
ranty Disclaimers, provided that you also include the original English version of this License
and the original versions of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice or disclaimer, the original
version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the
requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual
title.

9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided
for under this License. Any other attempt to copy, modify, sublicense or distribute the Document
is void, and will automatically terminate your rights under this License. However, parties who
have received copies, or rights, from you under this License will not have their licenses termi-
nated so long as such parties remain in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE


The Free Software Foundation may publish new, revised versions of the GNU Free Documenta-
tion License from time to time. Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/ .
Each version of the License is given a distinguishing version number. If the Document specifies
that a particular numbered version of this License "or any later version" applies to it, you have
the option of following the terms and conditions either of that specified version or of any later
version that has been published (not as a draft) by the Free Software Foundation. If the Document
does not specify a version number of this License, you may choose any version ever published
(not as a draft) by the Free Software Foundation.

ADDENDUM: How to use this License for your documents


Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2

40 9. TERMINATION SUSE Linux Enterp…


or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled “GNU
Free Documentation License”.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “ with…
Texts.” line with this:

with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three,
merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these
examples in parallel under your choice of free software license, such as the GNU General Public
License, to permit their use in free software.

41 ADDENDUM: How to use this License for your documents SUSE Linux Enterp…

You might also like