Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions asciidoc/DC-edge
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
#
# Elemental on OSX on Apple Silicon (UTM)
# SUSE Edge Documentation
#

# Sources
MAIN=edge.adoc
SRC_DIR=edge-book
IMG_SRC_DIR=images


# ASCIIDoc options
ADOC_POST=yes
ADOC_TYPE=book

# Set the flavor
# ADOC_ATTRIBUTES="--attribute flavor=edge"

# Stylesheets
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

# DocBook Validation
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.0/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
22 changes: 22 additions & 0 deletions asciidoc/DC-telco
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#
# Elemental on OSX on Apple Silicon (UTM)
#

# Sources
MAIN=telco.adoc
SRC_DIR=edge-book
IMG_SRC_DIR=images

# ASCIIDoc options
ADOC_POST=yes
ADOC_TYPE=book

# Set the flavor
# ADOC_ATTRIBUTES="--attribute flavor=telco"

# Stylesheets
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

# DocBook Validation
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
4 changes: 2 additions & 2 deletions asciidoc/components/edge-image-builder.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Edge Image Builder (EIB) is a tool that streamlines the generation of Customized
Whilst EIB can create CRB images for all provisioning scenarios, EIB demonstrates a tremendous value in air-gapped deployments with limited or completely isolated networks.


== How does SUSE Edge use Edge Image Builder?
== How does {product} use Edge Image Builder?

SUSE Edge uses EIB for the simplified and quick configuration of customized SUSE Linux Micro images for a variety of scenarios. These scenarios include the bootstrapping of virtual and bare-metal machines with:
{product} uses EIB for the simplified and quick configuration of customized SUSE Linux Micro images for a variety of scenarios. These scenarios include the bootstrapping of virtual and bare-metal machines with:

* Fully air-gapped deployments of K3s/RKE2 Kubernetes (single & multi-node)
* Fully air-gapped Helm chart and Kubernetes manifest deployments
Expand Down
6 changes: 3 additions & 3 deletions asciidoc/components/elemental.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ Elemental is a software stack enabling centralized and full cloud-native OS mana

See https://elemental.docs.rancher.com/[Elemental upstream documentation] for full information about Elemental and its relationship to Rancher.

== How does SUSE Edge use Elemental?
== How does {product} use Elemental?

We use portions of Elemental for managing remote devices where Metal^3^ is not an option (for example, there is no BMC, or the device is behind a NAT gateway). This tooling allows for an operator to bootstrap their devices in a lab before knowing when or where they will be shipped to. Namely, we leverage the `elemental-register` and `elemental-system-agent` components to enable the onboarding of SUSE Linux Micro hosts to Rancher for "phone home" network provisioning use-cases. When using Edge Image Builder (EIB) to create deployment images, the automatic registration through Rancher via Elemental can be achieved by specifying the registration configuration in the configuration directory for EIB.

NOTE: In SUSE Edge {version-edge} we do *not* leverage the operating system management aspects of Elemental, and therefore it's not possible to manage your operating system patching via Rancher. Instead of using the Elemental tools to build deployment images, SUSE Edge uses the Edge Image Builder tooling, which consumes the registration configuration.
NOTE: In {product} {version-edge} we do *not* leverage the operating system management aspects of Elemental, and therefore it's not possible to manage your operating system patching via Rancher. Instead of using the Elemental tools to build deployment images, {product} uses the Edge Image Builder tooling, which consumes the registration configuration.

== Best practices

=== Installation media

The SUSE Edge recommended way of building deployments image that can leverage Elemental for registration to Rancher in the "phone home network provisioning" deployment footprint is to follow the instructions detailed in the <<quickstart-elemental,remote host onboarding with Elemental>> quickstart.
The {product} recommended way of building deployments image that can leverage Elemental for registration to Rancher in the "phone home network provisioning" deployment footprint is to follow the instructions detailed in the <<quickstart-elemental,remote host onboarding with Elemental>> quickstart.

=== Labels

Expand Down
4 changes: 2 additions & 2 deletions asciidoc/components/endpoint-copier-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ endif::[]

https://github.com/suse-edge/endpoint-copier-operator[Endpoint Copier Operator] is a Kubernetes operator whose purpose is to create a copy of a Kubernetes Service and Endpoint and to keep them synced.

== How does SUSE Edge use Endpoint Copier Operator?
== How does {product} use Endpoint Copier Operator?

At SUSE Edge, the Endpoint Copier Operator plays a crucial role in achieving High Availability (HA) setup for K3s/RKE2 clusters. This is accomplished by creating a `kubernetes-vip` service of type `LoadBalancer`, ensuring its Endpoint remains in constant synchronization with the kubernetes Endpoint. <<components-metallb,MetalLB>> is leveraged to manage the `kubernetes-vip` service, as the exposed IP address is used from other nodes to join the cluster.
At {product}, the Endpoint Copier Operator plays a crucial role in achieving High Availability (HA) setup for K3s/RKE2 clusters. This is accomplished by creating a `kubernetes-vip` service of type `LoadBalancer`, ensuring its Endpoint remains in constant synchronization with the kubernetes Endpoint. <<components-metallb,MetalLB>> is leveraged to manage the `kubernetes-vip` service, as the exposed IP address is used from other nodes to join the cluster.

== Best Practices

Expand Down
10 changes: 5 additions & 5 deletions asciidoc/components/k3s.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ https://k3s.io/[K3s] is a highly available, certified Kubernetes distribution de

It is packaged as a single and small binary, so installations and updates are fast and easy.

== How does SUSE Edge use K3s
== How does {product} use K3s

K3s can be used as the Kubernetes distribution backing the SUSE Edge stack.
K3s can be used as the Kubernetes distribution backing the {product} stack.
It is meant to be installed on a SUSE Linux Micro operating system.

Using K3s as the SUSE Edge stack Kubernetes distribution is only recommended when etcd as a backend does not fit your constraints. If etcd as a backend is possible, it is better to use <<components-rke2,RKE2>>.
Using K3s as the {product} stack Kubernetes distribution is only recommended when etcd as a backend does not fit your constraints. If etcd as a backend is possible, it is better to use <<components-rke2,RKE2>>.

== Best practices

=== Installation
The recommended way of installing K3s as part of the SUSE Edge stack is by using Edge Image Builder (EIB). See <<components-eib,its documentation>> for more details on how to configure it to deploy K3s.
The recommended way of installing K3s as part of the {product} stack is by using Edge Image Builder (EIB). See <<components-eib,its documentation>> for more details on how to configure it to deploy K3s.

It automatically supports HA setup, as well as Elemental setup.

=== Fleet for GitOps workflow
The SUSE Edge stack uses Fleet as its preferred GitOps tool.
The {product} stack uses Fleet as its preferred GitOps tool.
For more information around its installation and use, refer to <<components-fleet,the Fleet section>> in this documentation.

=== Storage management
Expand Down
4 changes: 2 additions & 2 deletions asciidoc/components/linux-micro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ____
SUSE Linux Micro is a lightweight and secure operating system for the edge. It merges the enterprise-hardened components of SUSE Linux Enterprise with the features that developers want in a modern, immutable operating system. As a result, you get a reliable infrastructure platform with best-in-class compliance that is also simple to use.
____

== How does SUSE Edge use SUSE Linux Micro?
== How does {product} use SUSE Linux Micro?

We use SUSE Linux Micro as the base operating system for our platform stack. This provides us with a secure, stable and minimal base for building upon.

Expand All @@ -31,7 +31,7 @@ SUSE Linux Micro is unique in its use of file system (Btrfs) snapshots to allow

=== Installation media

SUSE Edge uses the <<components-eib,Edge Image Builder>> to preconfigure the SUSE Linux Micro self-install installation image.
{product} uses the <<components-eib,Edge Image Builder>> to preconfigure the SUSE Linux Micro self-install installation image.

=== Local administration

Expand Down
2 changes: 1 addition & 1 deletion asciidoc/components/longhorn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ kubectl -n longhorn-system get svc

== Installing with Edge Image Builder

SUSE Edge is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
{product} is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
We are going to demonstrate how to do so for provisioning an RKE2 cluster with SUSE Storage on top of it.

Let's create the definition file:
Expand Down
6 changes: 3 additions & 3 deletions asciidoc/components/metal3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ This enables management of hardware resources across multiple
infrastructure providers via broadly adopted vendor-neutral APIs.
Cluster API uses Metal^3^ as an infrastructure backend for Machine objects.

== How does SUSE Edge use Metal^3^?
== How does {product} use Metal^3^?

SUSE Edge uses Metal^3^ to manage the lifecycle of physical hardware, such as
{product} uses Metal^3^ to manage the lifecycle of physical hardware, such as
servers. The hardware needs to support an out-of-band management protocol that
is supported by Metal^3^ (e.g. Redfish). When a SUSE Edge management cluster
is supported by Metal^3^ (e.g. Redfish). When a {product} management cluster
provisions or deprovisions downstream clusters, Metal^3^ will interact with a
server's BMC via Redfish. The following actions are typically part of this
interaction: +
Expand Down
4 changes: 2 additions & 2 deletions asciidoc/components/metallb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ MetalLB addresses these challenges by harnessing the Kubernetes model to create
There are two different approaches, via https://metallb.universe.tf/concepts/layer2/[L2 mode] (using ARP _tricks_) or via https://metallb.universe.tf/concepts/bgp/[BGP]. Mainly L2 does not need any special network gear but BGP is in general better. It depends on the use cases.
____

== How does SUSE Edge use MetalLB?
== How does {product} use MetalLB?

SUSE Edge uses MetalLB in three key ways:
{product} uses MetalLB in three key ways:

* As a Load Balancer Solution: MetalLB serves as the Load Balancer solution for bare-metal machines.
* For an HA K3s/RKE2 Setup: MetalLB allows for load balancing the Kubernetes API using a Virtual IP address.
Expand Down
13 changes: 7 additions & 6 deletions asciidoc/components/networking.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ifdef::env-github[]
:warning-caption: :warning:
endif::[]

This section describes the approach to network configuration in the SUSE Edge solution.
This section describes the approach to network configuration in the {product} solution.
We will show how to configure NetworkManager on SUSE Linux Micro in a declarative manner, and explain how the related tools are integrated.

== Overview of NetworkManager
Expand All @@ -34,17 +34,18 @@ Details about nmstate can be found in the https://nmstate.io/[upstream documenta

== Enter: NetworkManager Configurator (nmc)

The network customization options available in SUSE Edge are achieved via a CLI tool called NetworkManager Configurator or _nmc_ for short.
The network customization options available in {product} are achieved via a CLI tool called NetworkManager Configurator or _nmc_ for short.
It is leveraging the functionality provided by the nmstate library and, as such, it is fully capable of configuring static IP addresses, DNS servers, VLANs, bonding, bridges, etc.
This tool allows us to generate network configurations from predefined desired states and to apply those across many different nodes in an automated fashion.

Details about the NetworkManager Configurator (nmc) can be found in the https://github.com/suse-edge/nm-configurator[upstream repository].

== How does SUSE Edge use NetworkManager Configurator?

SUSE Edge utilizes _nmc_ for the network customizations in the various different provisioning models:
== How does {product} use NetworkManager Configurator?

{product} utilizes _nmc_ for the network customizations in the various different provisioning models:
ifeval::["{flavor}" == "telco"]
* Custom network configurations in the Directed Network Provisioning scenarios (<<quickstart-metal3>>)
endif::[]
* Declarative static configurations in the Image Based Provisioning scenarios (<<quickstart-eib>>)

== Configuring with Edge Image Builder
Expand All @@ -62,7 +63,7 @@ If you're following this guide, it's assumed that you've got the following alrea

=== Getting the Edge Image Builder container image

The EIB container image is publicly available and can be downloaded from the SUSE Edge registry by running:
The EIB container image is publicly available and can be downloaded from the {product} registry by running:

[,shell,subs="attributes"]
----
Expand Down
6 changes: 3 additions & 3 deletions asciidoc/components/neuvector.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ environment.

A more in-depth SUSE Security onboarding and best practices documentation can be found https://open-docs.neuvector.com/[here].

== How does SUSE Edge use SUSE Security?
== How does {product} use SUSE Security?

SUSE Edge provides a leaner configuration of SUSE Security as a starting point for edge deployments.
{product} provides a leaner configuration of SUSE Security as a starting point for edge deployments.

== Important notes

Expand All @@ -61,5 +61,5 @@ and possible payload (DLP). Increasing memory and dedicating a CPU core to the

== Installing with Edge Image Builder

SUSE Edge is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
{product} is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
Follow <<suse-security-install>> for an air-gapped installation of SUSE Security on top of Kubernetes clusters provisioned by EIB.
8 changes: 4 additions & 4 deletions asciidoc/components/rancher-dashboard-extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ ifdef::env-github[]
:warning-caption: :warning:
endif::[]

Extensions allow users, developers, partners, and customers to extend and enhance the Rancher UI. SUSE Edge provides KubeVirt dashboard extensions.
Extensions allow users, developers, partners, and customers to extend and enhance the Rancher UI. {product} provides KubeVirt dashboard extensions.

See `{link-rancher-extensions}[Rancher documentation]` for general information about Rancher Dashboard Extensions.

== Installation

All of the SUSE Edge {version-edge} components, including dashboard extensions, are distributed as OCI artifacts. To install SUSE Edge Extensions you can use Rancher Dashboard UI, Helm or Fleet:
All of the {product} {version-edge} components, including dashboard extensions, are distributed as OCI artifacts. To install {product} Extensions you can use Rancher Dashboard UI, Helm or Fleet:

=== Installing with Rancher Dashboard UI

. Click *Extensions* in the *Configuration* section of the navigation sidebar.
. On the Extensions page, click the three dot menu at the top right and select *Manage Repositories*.
+
Each extension is distributed via its own OCI artifact. They are available from the SUSE Edge Helm charts repository.
Each extension is distributed via its own OCI artifact. They are available from the {product} Helm charts repository.

. On the *Repositories page*, click `Create`.
. In the form, specify the repository name and URL, and click `Create`.
+
SUSE Edge Helm charts repository URL:
{product} Helm charts repository URL:
`oci://registry.suse.com/edge/charts`
+
image::dashboard-extensions-create-oci-repository.png[scaledwidth=100%]
Expand Down
10 changes: 5 additions & 5 deletions asciidoc/components/rancher.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ ____
* **Centralized application catalog:** The Rancher application catalog offers a diverse range of Helm charts and Kubernetes Operators, making it easy to deploy and manage containerized applications.
* **Continuous delivery:** Rancher supports GitOps and CI/CD pipelines, enabling automated and streamlined application delivery processes.

== Rancher's use in SUSE Edge
== Rancher's use in {product}

Rancher provides several core functionalities to the SUSE Edge stack:
Rancher provides several core functionalities to the {product} stack:

=== Centralized Kubernetes management

Expand All @@ -44,11 +44,11 @@ Rancher streamlines Kubernetes cluster creation on the lightweight SUSE Linux Mi

=== Application deployment and management

The integrated Rancher application catalog can simplify deploying and managing containerized applications across SUSE Edge clusters, enabling seamless edge workload deployment.
The integrated Rancher application catalog can simplify deploying and managing containerized applications across {product} clusters, enabling seamless edge workload deployment.

=== Security and policy enforcement

Rancher provides policy-based governance tools, role-based access control (RBAC), and integration with external authentication providers. This helps SUSE Edge deployments maintain security and compliance, critical in distributed environments.
Rancher provides policy-based governance tools, role-based access control (RBAC), and integration with external authentication providers. This helps {product} deployments maintain security and compliance, critical in distributed environments.

== Best practices

Expand All @@ -62,7 +62,7 @@ Rancher includes built-in monitoring and logging tools like Prometheus and Grafa

== Installing with Edge Image Builder

SUSE Edge is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
{product} is using <<components-eib>> in order to customize base SUSE Linux Micro OS images.
Follow <<rancher-install>> for an air-gapped installation of Rancher on top of Kubernetes clusters provisioned by EIB.

== Additional Resources
Expand Down
Loading
Loading