Skip to content

Commit c6b51d9

Browse files
authored
Merge pull request #63830 from opayne1/OSDOCS-6661
OSDOCS-6661: Updates to MicroShift manifests
2 parents 4dcfe81 + 5629c32 commit c6b51d9

6 files changed

+55
-13
lines changed

microshift_running_apps/microshift-applications.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ You can use the `kustomize` configuration management tool to deploy applications
1010

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

13+
include::modules/microshift-manifests-override-paths.adoc[leveloffset=+1]
14+
1315
include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1]

microshift_running_apps/microshift-greenboot-workload-scripts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ include::modules/microshift-greenboot-testing-workload-script.adoc[leveloffset=+
2222
[role="_additional-resources"]
2323
.Additional resources
2424
* xref:../microshift_install/microshift-greenboot.adoc#microshift-greenboot[The greenboot health check]
25-
* xref:../microshift_running_apps/microshift-applications.adoc#microshift-manifests-example_applications-microshift[Auto applying manifests]
25+
* xref:../microshift_running_apps/microshift-applications.adoc#microshift-applying-manifests-example_applications-microshift[Auto applying manifests]

microshift_running_apps/microshift-operators.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,4 @@ Operators offer a more localized configuration experience and integrate with Kub
1515
[id="how-to-install-operators_{context}"]
1616
== How to install Operators in {product-title}
1717

18-
To minimize the footprint of {product-title}, Operators are installed directly with manifests instead of using the Operator Lifecycle Manager (OLM). The following examples provide instructions on how you can use the `kustomize` configuration management tool with {product-title} to deploy an application. Use the same steps to install Operators with manifests.
19-
20-
include::modules/microshift-manifests-overview.adoc[leveloffset=+2]
21-
22-
include::modules/microshift-applying-manifests-example.adoc[leveloffset=+2]
18+
To minimize the footprint of {product-title}, Operators are installed directly with manifests instead of using the Operator Lifecycle Manager (OLM). You can use the `kustomize` configuration management tool with {product-title} to deploy an application. Use the same steps to install Operators with manifests. Read xref:../microshift_running_apps/microshift-applications.adoc#microshift-manifests-overview_applications-microshift[Application deployment with {product-title}] for more information about manifests.

modules/microshift-applying-manifests-example.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift/running_applications/microshift-operators.adoc
3+
// * microshift/running_applications/microshift-applications.adoc
44

55
:_content-type: PROCEDURE
6-
[id="microshift-manifests-example_{context}"]
6+
[id="microshift-applying-manifests-example_{context}"]
77
= Using manifests example
88
This example demonstrates automatic deployment of a BusyBox container using `kustomize` manifests in the `/etc/microshift/manifests` directory.
99

@@ -29,7 +29,6 @@ $ sudo mkdir -p ${MANIFEST_DIR}
2929
[source,terminal]
3030
----
3131
$ sudo tee ${MANIFEST_DIR}/busybox.yaml &>/dev/null <<EOF
32-
3332
apiVersion: v1
3433
kind: Namespace
3534
metadata:
@@ -39,6 +38,7 @@ apiVersion: apps/v1
3938
kind: Deployment
4039
metadata:
4140
name: busybox-deployment
41+
namespace:busybox
4242
spec:
4343
selector:
4444
matchLabels:
@@ -64,15 +64,14 @@ EOF
6464
[source,terminal]
6565
----
6666
$ sudo tee ${MANIFEST_DIR}/kustomization.yaml &>/dev/null <<EOF
67-
---
6867
apiVersion: kustomize.config.k8s.io/v1beta1
6968
kind: Kustomization
7069
namespace: busybox
7170
resources:
7271
- busybox.yaml
7372
images:
7473
- name: BUSYBOX_IMAGE
75-
newName: registry.k8s.io/busybox
74+
newName: busybox:1.35
7675
EOF
7776
----
7877

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift//running_applications/microshift-applications.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="microshift-manifests-override-paths_{context}"]
7+
= Override the list of manifest paths
8+
You can override the list of default manifest paths by using a new single path, or by using a new glob pattern for multiple files. Use the following procedure to customize your manifest paths.
9+
10+
.Procedure
11+
12+
. Override the list of default paths by inserting your own values and running one of the following commands:
13+
14+
.. Set `manifests.kustomizePaths` to `<++"++/opt/alternate/path++"++>` in the configuration file for a single path.
15+
16+
.. Set `kustomizePaths` to `,++"++/opt/alternative/path.d/++*"++.` in the configuration file for a glob pattern.
17+
+
18+
[source,terminal]
19+
----
20+
manifests:
21+
kustomizePaths:
22+
- <location> <1>
23+
----
24+
<1> Set each location entry to an exact path by using `++"++/opt/alternate/path++"++` or a glob pattern by using `++"++/opt/alternative/path.d/++*"++`.
25+
26+
. To disable loading manifests, set the configuration option to an empty list.
27+
+
28+
[source,terminal]
29+
----
30+
manifests:
31+
kustomizePaths: []
32+
----
33+
+
34+
[NOTE]
35+
====
36+
The configuration file overrides the defaults entirely. If the `kustomizePaths` value is set, only the values in the configuration file are used. Setting the value to an empty list disables manifest loading.
37+
====
Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift/using-config-tools.adoc
3+
// * microshift//running_applications/microshift-applications.adoc
44

55
:_content-type: CONCEPT
66
[id="microshift-manifests-overview_{context}"]
77
= How manifests work with kustomize
88

9-
The `kustomize` configuration management tool is integrated with {product-title}. At every start, {product-title} searches the `/etc/microshift/manifests` and `/usr/lib/microshift/` manifest directories for a `kustomization.yaml` file. If it finds one, {product-title} automatically runs the equivalent of the `kubectl apply -k` command to apply the identified manifests to the cluster.
9+
The `kustomize` configuration management tool is integrated with {product-title}. At every start, {product-title} searches the `/etc/microshift/manifests`, `/etc/microshift/manifests.d/++*++`, `/usr/lib/microshift/`, and `/usr/lib/microshift/manifests.d/++*++` manifest directories for a `kustomization.yaml`, `kustomization.yml`, or `Kustomization` file. If it finds one, {product-title} automatically runs the equivalent of the `kubectl apply -k` command to apply the identified manifests to the cluster.
10+
11+
Loading from multiple directories allows you to manage {product-title} workloads with more flexibility. Different workloads can be independent of each other.
1012

1113
[cols="2",options="header"]
1214
|===
@@ -16,6 +18,12 @@ The `kustomize` configuration management tool is integrated with {product-title}
1618
|`/etc/microshift/manifests`
1719
|Read-write location for configuration management systems or development.
1820

21+
|`/etc/microshift/manifests.d/*`
22+
|Read-write location for configuration management systems or development.
23+
1924
|`/usr/lib/microshift/manifests`
2025
|Read-only location for embedding configuration manifests on OSTree-based systems.
26+
27+
|`/usr/lib/microshift/manifestsd./*`
28+
|Read-only location for embedding configuration manifests on OSTree-based systems.
2129
|===

0 commit comments

Comments
 (0)