Skip to content

Commit aad164c

Browse files
committed
OSDOCS-9598: pre-pub 4.16 MicroShift nits
1 parent 074f127 commit aad164c

File tree

11 files changed

+29
-70
lines changed

11 files changed

+29
-70
lines changed

microshift_configuring/microshift-audit-logs-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-audit-logs-config"]
3-
= Customizing audit logging policies
3+
= Configuring audit logging policies
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-audit-logs-config
66

microshift_configuring/microshift-custom-ca.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ include::modules/microshift-custom-ca-troubleshooting.adoc[leveloffset=+1]
2222

2323
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/creating-and-managing-tls-keys-and-certificates_securing-networks#doc-wrapper[RHEL: Creating and managing TLS keys and certificates]
2424

25-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/using-shared-system-certificates_securing-networks#the-system-wide-trust-store_using-shared-system-certificates[The system-wide truststore] for details.
25+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/using-shared-system-certificates_securing-networks#the-system-wide-trust-store_using-shared-system-certificates[The system-wide truststore]
2626

2727
* link:https://docs.openshift.com/container-platform/{ocp-version}/cli_reference/openshift_cli/managing-cli-profiles.html[OpenShift CLI Reference: oc login]

microshift_install/microshift-greenboot.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88

99
Greenboot is the generic health check framework for the `systemd` service on `rpm-ostree` systems such as {op-system-ostree-first}. This framework is included in {microshift-short} installations with the `microshift-greenboot` and `greenboot-default-health-checks` RPM packages.
1010

11-
Greenboot health checks run at various times to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example:
11+
Greenboot health checks run at various times to assess system health and automate a rollback on `rpm-ostree` systems to the last healthy state in cases of software trouble, for example:
1212

1313
* Default health check scripts run each time the system starts.
1414
* In addition the to the default health checks, you can write, install, and configure application health check scripts to also run every time the system starts.
@@ -17,11 +17,6 @@ Greenboot health checks run at various times to assess system health and automat
1717
1818
A {microshift-short} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM includes health check scripts verifying that DNS and `ostree` services are accessible. You can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example.
1919

20-
[NOTE]
21-
====
22-
Rollback is not possible in the case of an update failure on a system not using `rpm-ostree`. This is true even though health checks might run.
23-
====
24-
2520
include::modules/microshift-greenboot-dir-structure.adoc[leveloffset=+1]
2621

2722
include::modules/microshift-greenboot-microshift-health-script.adoc[leveloffset=+1]

microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
In addition to the default OVN-Kubernetes Container Network Interface (CNI) plugin, {microshift-short} uses an implementation of the Multus CNI to chain other CNI plugins.
9+
In addition to the default OVN-Kubernetes Container Network Interface (CNI) plugin, the {microshift-short} Multus CNI is available to chain other CNI plugins. Installing and using {microshift-short} Multus is optional.
1010

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

microshift_running_apps/microshift-gitops.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@ include::modules/microshift-gitops-adding-apps.adoc[leveloffset=+1]
3030
GitOps with Argo CD for {microshift-short} has the following differences from the Red Hat OpenShift GitOps Operator:
3131

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

3737
[id="microshift-gitops-troubleshooting_{context}"]
3838
== Troubleshooting GitOps
39-
If you have problems with your GitOps controller, you can use either the {oc-first} tool or run an sos report.
39+
If you have problems with your GitOps controller, you can use the {oc-first} tool.
4040

4141
include::modules/microshift-gitops-debug.adoc[leveloffset=+2]
4242

43-
include::modules/microshift-gathering-sos-report.adoc[leveloffset=+2]
44-
4543
[id="additional-resources_microshift-gitops_{context}"]
4644
[role="_additional-resources"]
4745
== Additional resources
46+
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package]
47+
4848
* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[Using sos reports]
4949

5050
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_gitops/1.12[Red Hat OpenShift GitOps]

microshift_troubleshooting/microshift-troubleshoot-backup-restore.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Data backups are automatic on `rpm-ostree` systems. If you are not using an `rpm
2121

2222
[id="troubleshoot-backup-restore-microshift-backup-logs_{context}"]
2323
== Backup logs
24-
* Logs print to the console during manual backups.
24+
* Logs print to the terminal console during manual backups.
2525
* Logs are automatically generated for `rpm-ostree` system automated backups as part of the {microshift-short} journal logs. You can check the logs by running the following command:
2626
+
2727
[source,terminal]

modules/microshift-custom-ca-con.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ If any validation fails, the {microshift-short} service skips the custom configu
4141

4242
[IMPORTANT]
4343
====
44-
Custom server certificates have to be validated against CA data configured in the trust root of the host operating system.
44+
Custom server certificates have to be validated against CA data configured in the trust root of the host operating system. For information, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/using-shared-system-certificates_securing-networks#the-system-wide-trust-store_using-shared-system-certificates[The system-wide truststore].
4545
====

modules/microshift-gitops-adding-apps.adoc

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,15 @@
88

99
You can create a custom YAML configuration to deploy and manage applications in your {microshift-short} service. To install the necessary packages to run GitOps applications, follow the documentation in "Installing the GitOps Argo CD manifests from an RPM package".
1010

11-
.Prerequisites
11+
.Prerequisites
1212

13-
* You installed the `microshift-gitops` packages and the Argo CD pods are running in the `openshift-gitops` namespace.
13+
* You installed the `microshift-gitops` packages.
1414
15-
.Procedure
15+
* The Argo CD pods are running in the `openshift-gitops` namespace.
1616
17-
. Create a YAML file and add your customized configurations for the application:
18-
+
19-
.Example YAML for a `cert-manager` application
20-
[source,yaml]
21-
----
22-
kind: AppProject
23-
apiVersion: argoproj.io/v1alpha1
24-
metadata:
25-
name: default
26-
namespace: openshift-gitops
27-
spec:
28-
clusterResourceWhitelist:
29-
- group: '*'
30-
kind: '*'
31-
destinations:
32-
- namespace: '*'
33-
server: '*'
34-
sourceRepos:
35-
- '*'
36-
---
37-
apiVersion: argoproj.io/v1alpha1
38-
kind: Application
39-
metadata:
40-
name: cert-manager
41-
namespace: openshift-gitops
42-
spec:
43-
destination:
44-
namespace: cert-manager
45-
server: https://kubernetes.default.svc
46-
project: default
47-
source:
48-
path: cert-manager
49-
repoURL: https://github.com/anandf/microshift-install
50-
syncPolicy:
51-
automated: {}
52-
syncOptions:
53-
- CreateNamespace=true
54-
- ServerSideApply=true
55-
----
17+
.Procedure
18+
19+
. Create a YAML file and add your customized configurations for the application:
5620
+
5721
.Example YAML for a `spring-petclinic` application
5822
[source,yaml]
@@ -98,10 +62,11 @@ spec:
9862
+
9963
[source,terminal]
10064
----
101-
$ oc apply -f <filename>.yaml
65+
$ oc apply -f <my-app>.yaml <1>
10266
----
67+
<1> Replace _<my-app>_ with the name of your application YAML.
10368

104-
.Verification
69+
.Verification
10570

10671
* To verify your application is deployed and synced, run the following command:
10772
+
@@ -111,10 +76,9 @@ $ oc get applications -A
11176
----
11277
It might take a few minutes for the application to show the `Healthy` status.
11378
+
114-
.Example output
79+
.Example output
11580
[source,terminal]
11681
----
11782
NAMESPACE NAME SYNC STATUS HEALTH STATUS
118-
openshift-gitops cert-manager Synced Healthy
11983
openshift-gitops spring-petclinic Synced Healthy
12084
----

modules/microshift-multus-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Setting network policies for additional networks is not supported.
2828
[id="microshift-additional-network-use-cases_{context}"]
2929
== Use case: Additional networks for network isolation
3030

31-
You can use an additional network in situations where network isolation is needed, including control plane and data plane separation. You can create additional interfaces for pods to connect to that network in addition to a default. For example, you can configure an additional interface if you want pods to access a network on the host and also communicate with devices deployed to the edge. These edge devices might be on an isolated operator network or are periodically disconnected.
31+
You can use an additional network in situations where network isolation is needed, including control plane and data plane separation. For example, you can configure an additional interface if you want pods to access a network on the host and also communicate with devices deployed to the edge. These edge devices might be on an isolated operator network or are periodically disconnected.
3232

3333
Isolating network traffic is useful for the following performance and security reasons:
3434

modules/microshift-nw-multus-add-pod.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ apiVersion: v1
2828
kind: Pod
2929
metadata:
3030
annotations:
31-
k8s.v1.cni.cncf.io/networks: <network>[,<network>,...] <1>
31+
k8s.v1.cni.cncf.io/networks: <network>[,<network>,...] # <1>
3232
# ...
3333
----
3434
<1> Replace `<network>` with the name of the additional network to associate with the pod. To specify more than one additional network, separate each network with a comma. Do not include whitespace between the comma. If you specify the same additional network multiple times, that pod will have multiple network interfaces attached to that network.
@@ -56,9 +56,9 @@ metadata:
5656
k8s.v1.cni.cncf.io/networks: |-
5757
[
5858
{
59-
"name": "<network>", <1>
60-
"namespace": "<namespace>", <2>
61-
"default-route": ["<default-route>"] <3>
59+
"name": "<network>", # <1>
60+
"namespace": "<namespace>", # <2>
61+
"default-route": ["<default-route>"] # <3>
6262
}
6363
]
6464
# ...
@@ -151,7 +151,7 @@ kind: Pod
151151
metadata:
152152
annotations:
153153
k8s.v1.cni.cncf.io/networks: bridge-conf
154-
k8s.v1.cni.cncf.io/network-status: |- <1>
154+
k8s.v1.cni.cncf.io/network-status: |- # <1>
155155
[{
156156
"name": "ovn-kubernetes",
157157
"interface": "eth0",

0 commit comments

Comments
 (0)