Skip to content
Merged
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
14 changes: 7 additions & 7 deletions _topic_maps/_topic_map_ms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Topics:
File: microshift-operators-olm
- Name: Creating custom catalogs with oc-mirror
File: microshift-operators-oc-mirror
- Name: Adding OLM-based Operators to a disconnected cluster
- Name: Adding OLM-based Operators to a disconnected node
File: microshift-operators-oc-mirror-disconnected
---
Name: Backup and restore
Expand All @@ -270,21 +270,21 @@ Topics:
File: microshift-etcd
- Name: The sos report tool
File: microshift-sos-report
- Name: Getting your cluster ID
File: microshift-getting-cluster-id
- Name: Getting your node ID
File: microshift-getting-node-id
- Name: Getting support
File: microshift-getting-support
- Name: Remote health monitoring with a connected cluster
File: microshift-remote-cluster-monitoring
- Name: Remote health monitoring with a connected node
File: microshift-remote-node-monitoring
---
Name: Troubleshooting
Dir: microshift_troubleshooting
Distros: microshift
Topics:
- Name: Check your version
File: microshift-version
- Name: Troubleshoot the cluster
File: microshift-troubleshoot-cluster
- Name: Troubleshoot the node
File: microshift-troubleshoot-node
- Name: Troubleshoot installation issues
File: microshift-installing-troubleshooting
- Name: Troubleshoot backup and restore
Expand Down
2 changes: 1 addition & 1 deletion microshift_cli_ref/microshift-cli-using-oc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The optional {oc-first} tool provides a subset of `oc` commands for {microshift-
include::modules/microshift-cli-oc-about.adoc[leveloffset=+1]

[id="cli-using-cli_{context}"]
== Using oc with a {microshift-short} cluster
== Using oc with a {microshift-short} node

Review the following sections to learn how to complete common tasks in {microshift-short} using the `oc` CLI.

Expand Down
2 changes: 1 addition & 1 deletion microshift_cli_ref/microshift-usage-oc-kubectl.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Kubernetes command-line interface (CLI), `kubectl`, can be used to run comma
[id="microshift-kubectl-binary_{context}"]
== The kubectl CLI tool

You can use the `kubectl` CLI tool to interact with Kubernetes primitives on your {microshift-short} cluster. You can also use existing `kubectl` workflows and scripts for users coming from another Kubernetes environment, or for those who prefer to use the `kubectl` CLI.
You can use the `kubectl` CLI tool to interact with Kubernetes primitives on your {microshift-short} node. You can also use existing `kubectl` workflows and scripts for users coming from another Kubernetes environment, or for those who prefer to use the `kubectl` CLI.

* The `kubectl` CLI tool is included in the archive when you download `oc`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

Learn about how `kubeconfig` files are used with {microshift-short} deployments. CLI tools use `kubeconfig` files to communicate with the API server of a cluster. These files provide cluster details, IP addresses, and other information needed for authentication.
Learn about how `kubeconfig` files are used with {microshift-short} deployments. CLI tools use `kubeconfig` files to communicate with the API server of a node. These files provide node details, IP addresses, and other information needed for authentication.

include::modules/microshift-kubeconfig-overview.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion microshift_configuring/microshift-using-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ include::modules/microshift-nw-advertise-address.adoc[leveloffset=+2]

include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+2]

[id="additional-resources_microshift-using-config-yaml_{context}"]
[id="additional-resources_microshift-using-config-yaml"]
[role="_additional-resources"]
== Additional resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ include::modules/microshift-tls-default-cipher-suites.adoc[leveloffset=+2]

* xref:../../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
* xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization with SCC]
* xref:../../microshift_configuring/microshift-node-access-kubeconfig#microshift-node-access-kubeconfig[Cluster access with kubeconfig]
* xref:../../microshift_configuring/microshift-node-access-kubeconfig#microshift-node-access-kubeconfig[Node access with kubeconfig]
* xref:../microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities]
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

You can use a custom container registry when you deploy {microshift-short} in a disconnected network. Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of container images in a private registry.
You can use a custom container registry when you deploy {microshift-short} in a disconnected network. Running your node in a restricted network without direct internet connectivity is possible by installing the node from a mirrored set of container images in a private registry.

include::modules/microshift-mirror-container-images.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

You can install optional RPM packages with {microshift-short} to provide additional cluster and application services.
You can install optional RPM packages with {microshift-short} to provide additional node and application services.

[id="microshift-install-rpm-add-ons"]
== Installing optional packages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

Embedding {microshift-short} containers in an `rpm-ostree` commit means that you can run a cluster in air-gapped, disconnected, or offline environments. You can embed {product-title} containers in a {op-system-ostree-first} image so that container engines do not need to pull images over a network from a container registry. Workloads can start immediately without network connectivity.
Embedding {microshift-short} containers in an `rpm-ostree` commit means that you can run a node in air-gapped, disconnected, or offline environments. You can embed {product-title} containers in a {op-system-ostree-first} image so that container engines do not need to pull images over a network from a container registry. Workloads can start immediately without network connectivity.

include::modules/microshift-embed-microshift-image-offline-deploy.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion microshift_networking/microshift-cni.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

The OVN-Kubernetes Container Network Interface (CNI) plugin is the default networking solution for the {microshift-short} node. OVN-Kubernetes is a virtualized network for pods and services that is based on Open Virtual Network (OVN).
The OVN-Kubernetes Container Network Interface (CNI) plugin is the default networking solution for a {microshift-short} node. OVN-Kubernetes is a virtualized network for pods and services that is based on Open Virtual Network (OVN).

* Default network configuration and connections are applied automatically in {microshift-short} with the `microshift-networking` RPM during installation.
* A node that uses the OVN-Kubernetes network plugin also runs Open vSwitch (OVS) on the node.
Expand Down
2 changes: 1 addition & 1 deletion microshift_networking/microshift-configuring-routes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

You can configure routes for services to have {microshift-short} cluster access.
You can configure routes for services to have {microshift-short} node access.

//OCP module, edit with care; Creating an insecure/http route
include::modules/microshift-nw-create-http-based-route.adoc[leveloffset=+1]
Expand Down
6 changes: 3 additions & 3 deletions microshift_networking/microshift-networking-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc::[]

Learn how to apply networking customization and default settings to {microshift-short} deployments. Each node is contained to a single machine and single {microshift-short}, so each deployment requires individual configuration, pods, and settings.

Cluster Administrators have several options for exposing applications that run inside a cluster to external traffic and securing network connections:
{microshift-short} administrators have several options for exposing applications that run inside a node to external traffic and securing network connections:

* A service such as NodePort

* API resources, such as `Ingress` and `Route`

By default, Kubernetes allocates each pod an internal IP address for applications running within the pod. Pods and their containers can have traffic between them, but clients outside the cluster do not have direct network access to pods except when exposed with a service such as NodePort.
By default, Kubernetes allocates each pod an internal IP address for applications running within the pod. Pods and their containers can have traffic between them, but clients outside the node do not have direct network access to pods except when exposed with a service such as NodePort.

include::modules/microshift-configuring-ovn.adoc[leveloffset=+1]

Expand All @@ -31,7 +31,7 @@ include::modules/microshift-ovs-snapshot.adoc[leveloffset=+1]
[id="microshift-about-load-balancer-service_{context}"]
== The {microshift-short} LoadBalancer service for workloads

{microshift-short} has a built-in implementation of network load balancers that you can use for your workloads and applications within the cluster. You can create a `LoadBalancer` service by configuring a pod to interpret ingress rules and serve as an ingress controller. The following procedure gives an example of a deployment-based `LoadBalancer` service.
{microshift-short} has a built-in implementation of network load balancers that you can use for your workloads and applications within the node. You can create a `LoadBalancer` service by configuring a pod to interpret ingress rules and serve as an ingress controller. The following procedure gives an example of a deployment-based `LoadBalancer` service.

include::modules/microshift-deploying-a-load-balancer.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In addition to the default OVN-Kubernetes Container Network Interface (CNI) plug

include::modules/microshift-multus-intro.adoc[leveloffset=+1]

include::modules/microshift-install-multus-running-cluster.adoc[leveloffset=+1]
include::modules/microshift-install-multus-running-node.adoc[leveloffset=+1]

//OCP module, edit with conditionals and care
include::modules/nw-multus-bridge-object.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

Learn how network policies work for {microshift-short} to restrict or allow network traffic to pods in your cluster.
Learn how network policies work for {microshift-short} to restrict or allow network traffic to pods in your node.

include::modules/microshift-nw-network-policy-intro.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ toc::[]

Use the following procedure to view a network policy for a namespace.

include::modules/nw-networkpolicy-view-cli.adoc[leveloffset=+1]
include::modules/nw-networkpolicy-view-cli.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]

{microshift-short} supports the deletion of manifest resources in the following situations:

* Manifest removal: Manifests can be removed when you need to completely remove a resource from the cluster.
* Manifest removal: Manifests can be removed when you need to completely remove a resource from the node.
* Manifest upgrade: During an application upgrade, some resources might need to be removed while others are retained to preserve data.

When creating new manifests, you can use manifest resource deletion to remove or update old objects, ensuring there are no conflicts or issues.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

You can embed microservices-based workloads and applications in a {op-system-ostree-first} image. Embedding means you can run a {product-title} cluster in air-gapped, disconnected, or offline environments.
You can embed microservices-based workloads and applications in a {op-system-ostree-first} image. Embedding means you can run a {microshift-short} node in air-gapped, disconnected, or offline environments.

include::modules/microshift-embed-images-offline-use.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} cluster. Embedded applications can be installed directly on edge devices to run in disconnected or offline environments.
You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} node. Embedded applications can be installed directly on edge devices to run in disconnected or offline environments.

[id="microshift-add-app-RPMs-to-rpm-ostree-image_{context}"]
== Adding application RPMs to an rpm-ostree image
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

The following tutorial gives a detailed example of how to embed applications in a {op-system-ostree} image for use in a {microshift-short} cluster in various environments.
The following tutorial gives a detailed example of how to embed applications in a {op-system-ostree} image for use in a {microshift-short} node in various environments.

include::modules/microshift-embed-app-rpms-tutorial.adoc[leveloffset=+1]

Expand Down
6 changes: 3 additions & 3 deletions microshift_running_apps/microshift-gitops.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

GitOps with Argo CD for {microshift-short} is a lightweight, optional add-on controller derived from the Red Hat OpenShift GitOps Operator. GitOps for {microshift-short} uses the command-line interface (CLI) of Argo CD to interact with the GitOps controller that acts as the declarative GitOps engine. You can consistently configure and deploy Kubernetes-based infrastructure and applications across clusters and development lifecycles.
GitOps with Argo CD for {microshift-short} is a lightweight, optional add-on controller derived from the Red Hat OpenShift GitOps Operator. GitOps for {microshift-short} uses the command-line interface (CLI) of Argo CD to interact with the GitOps controller that acts as the declarative GitOps engine. You can consistently configure and deploy Kubernetes-based infrastructure and applications across node and development lifecycles.

[id="microshift-gitops-can-do_{context}"]
== What you can do with the GitOps agent
By using the GitOps with Argo CD agent with {microshift-short}, you can utilize the following principles:

* Implement application lifecycle management.
** Create and manage your clusters and application configuration files using the core principles of developing and maintaining software in a Git repository.
** Create and manage your node and application configuration files using the core principles of developing and maintaining software in a Git repository.
** You can update the single repository and GitOps automates the deployment of new applications or updates to existing ones.
** For example, if you have 1,000 edge devices, each using {microshift-short} and a local GitOps agent, you can easily add or update an application on all 1,000 devices with just one change in your central Git repository.
* The Git repository contains a declarative description of the infrastructure you need in your specified environment and contains an automated process to make your environment match the described state.
Expand All @@ -31,7 +31,7 @@ GitOps with Argo CD for {microshift-short} has the following differences from th

* The `gitops-operator` component is not used with {microshift-short}.
* To maintain the small resource use of {microshift-short}, the Argo CD web console is not available. You can use the Argo CD CLI.
* Because {microshift-short} is single-node, there is no multi-cluster support. Each instance of {microshift-short} is paired with a local GitOps agent.
* Because {microshift-short} is single-node, there is no multi-node support. Each instance of {microshift-short} is paired with a local GitOps agent.
* The `oc adm must-gather` command is not available in {microshift-short}.

[id="microshift-gitops-troubleshooting_{context}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-operators-oc-mirror-disconnected"]
= Adding OLM-based Operators to a disconnected cluster
= Adding OLM-based Operators to a disconnected node
include::_attributes/attributes-microshift.adoc[]
:context: microshift-operators-oc-mirror-disconnected

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ include::modules/microshift-oc-mirror-to-mirror.adoc[leveloffset=+1]
//Convert the imageset file and add configuration to CRI-O
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+1]

//Apply changes to cluster so it can use Operators
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+1]
//Apply changes to node so it can use Operators
include::modules/microshift-oc-mirror-install-catalog-node.adoc[leveloffset=+1]

[id="Additional-resources_microshift-operators-oc-mirror_{context}"]
[role="_additional-resources"]
Expand Down
Loading