Skip to content

Commit a6d15b3

Browse files
authored
Merge pull request #84609 from openshift/revert-84521-OSDOCS-12183-1
Revert "OSDOCS-12183-1: changes in delete Kustomize manifest resources"
2 parents 2642802 + a82e551 commit a6d15b3

9 files changed

+20
-35
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Distros: microshift
195195
Topics:
196196
- Name: Using Kustomize to deploy applications
197197
File: microshift-applications
198-
- Name: Deleting or upgrading Kustomize manifest resources
198+
- Name: Deleting resource manifests
199199
File: microshift-deleting-resource-manifests
200200
- Name: Embedding applications on RHEL for Edge
201201
File: microshift-embedded-apps-on-rhel-edge

microshift_running_apps/microshift-applications.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,4 @@ include::modules/microshift-manifests-overview.adoc[leveloffset=+1]
1212

1313
include::modules/microshift-manifests-override-paths.adoc[leveloffset=+1]
1414

15-
//[id="additional-resources_applications-with-microshift_{context}"]
16-
[role="_additional-resources"]
17-
== Additional resources
18-
* xref:../microshift_running_apps/microshift-deleting-resource-manifests.adoc#microshift-deleting-resource-manifests[Deleting or upgrading Kustomize manifest resources]
19-
2015
include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1]
Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,34 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-deleting-resource-manifests"]
3-
= Deleting or upgrading Kustomize manifest resources
3+
= Deleting resource manifests
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-deleting-resource-manifests
66

77
toc::[]
88

9-
{microshift-short} supports the deletion of manifest resources in the following situations:
9+
{microshift-short} supports the deletion of resource manifests in the following situations:
1010

1111
* Manifest removal: Manifests can be removed when you need to completely remove a resource from the cluster.
1212
* Manifest upgrade: During an application upgrade, some resources might need to be removed while others are retained to preserve data.
1313
14-
When creating new manifests, you can use manifest resource deletion to remove or update old objects, ensuring there are no conflicts or issues.
14+
When creating new manifests, you can use resource manifest deletion to remove or update old objects, ensuring there are no conflicts or issues.
1515

1616
[IMPORTANT]
1717
====
18-
Manifest files placed in the `delete` subdirectories are not automatically removed and require manual deletion. Only the resources listed in the manifest files placed in the delete subdirectories are deleted.
18+
Manifest files placed in the `delete` subdirectories are not automatically removed and require manual deletion.
1919
====
2020

2121
include::modules/microshift-manifests-deletion-overview.adoc[leveloffset=+1]
2222

2323
[id="microshift-examples-of-usecase_{context}"]
24-
== Use cases for manifest resource deletion
24+
== Use cases for resource manifest deletion
2525

26-
The following explains the use case in which the manifest resource deletion is used.
26+
The following explains the use case in which the resource manifest deletion is used.
2727

2828
include::modules/microshift-manifests-removal-scenario-rpm.adoc[leveloffset=+2]
2929

3030
include::modules/microshift-manifests-removal-scenario-ostree.adoc[leveloffset=+2]
3131

3232
include::modules/microshift-manifests-upgrade-scenario-rpm.adoc[leveloffset=+2]
3333

34-
include::modules/microshift-manifests-upgrade-scenario-ostree.adoc[leveloffset=+2]
35-
36-
//[id="additional-resources_microshift-deleting-resource-manifests_{context}"]
37-
[role="_additional-resources"]
38-
== Additional resources
39-
* xref:../microshift_running_apps/microshift-applications.adoc#applications-with-microshift[Using Kustomize manifests to deploy applications]
34+
include::modules/microshift-manifests-upgrade-scenario-ostree.adoc[leveloffset=+2]

modules/microshift-manifests-deletion-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
By default, {microshift-short} searches for deletion manifests in the `delete` subdirectories within the manifests path. When a user places a manifest in these subdirectories, {microshift-short} removes the manifests when the system is started. Read through the following to understand how manifests deletion works in {microshift-short}.
1010

11-
. Each time the system starts, before applying the manifests, {microshift-short} scans the following `delete` subdirectories within the configured manifests directory to identify the manifests that need to be deleted:
11+
. Each time the system starts, before applying the manifests, {microshift-short} scans the following `delete` subdirectories within the configured manifests directory to identify the Kustomize manifests that need to be deleted:
1212

1313
* /usr/lib/microshift/manifests/delete
1414
* /usr/lib/microshift/manifests.d/delete/*
1515
* /etc/microshift/manifests/delete
1616
* /etc/microshift/manifests.d/delete/*
1717
18-
. {microshift-short} deletes the resources defined in the manifests found in the `delete` directories by running the equivalent of the `kubectl delete --ignore-not-found -k` command.
18+
. {microshift-short} deletes the resources defined in the Kustomize manifests found in the `delete` directories by running the equivalent of the `kubectl delete --ignore-not-found -k` command.

modules/microshift-manifests-overview.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@ The `kustomize` configuration management tool is integrated with {microshift-sho
1313
* Using a manifest copy with an overlay keeps the original configuration file for your application intact, while enabling you to deploy iterations and customizations of your applications efficiently.
1414
* You can then deploy the application in your {microshift-short} cluster with an `oc` command.
1515
16-
[NOTE]
17-
====
18-
At each system start, {microshift-short} deletes the manifests found in the `delete` subdirectories and then applies the manifest files found in the manifest directories to the cluster.
19-
====
20-
2116
[id="how-microshift-uses-manifests"]
2217
== How {microshift-short} uses manifests
2318
At every start, {microshift-short} searches the following manifest directories for Kustomize manifest files:

modules/microshift-manifests-removal-scenario-ostree.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="microshift-manifests-removal-scenario-ostree_{context}"]
77
= Removing manifests for OSTree systems
88

9-
Use the following procedure to completely delete the resource defined in the manifests.
9+
Use the following procedure to completely delete the resource defined in the Kustomize manifests.
1010

1111
[IMPORTANT]
1212
====
13-
For OSTree installation, the `delete` subdirectories are read-only.
13+
For OSTree installation, the `delete` subdirectories are read only.
1414
====
1515

1616
.Procedure

modules/microshift-manifests-removal-scenario-rpm.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="microshift-manifests-removal-scenario-rpm_{context}"]
77
= Removing manifests for RPM systems
88

9-
Use the following procedure in the data removal scenario for RPM systems to completely delete the resource defined in the manifests.
9+
Use the following procedure in the data removal scenario for RPM systems to completely delete the resource defined in the Kustomize manifests.
1010

1111
.Procedure
1212

@@ -15,16 +15,16 @@ Use the following procedure in the data removal scenario for RPM systems to comp
1515
+
1616
[source,terminal]
1717
----
18-
$ sudo mkdir -p <path_of_delete_directory> <1>
18+
$ sudo mkdir -p _<path_of_delete_directory>_ <1>
1919
----
20-
<1> Replace `_<path_of_delete_directory>_` with one of the following valid directory paths: `/etc/microshift/manifests.d/delete`, `/etc/microshift/manifests/delete/`, `/usr/lib/microshift/manifests.d/delete` or `/usr/lib/microshift/manifests/delete`.
20+
<1> Replace `_<path_of_delete_directory>_` with the path of the delete subdirectory, for example, `/etc/microshift/manifests.d/delete`, `/etc/microshift/manifests/delete/`, `/usr/lib/microshift/manifests.d/delete` or `/usr/lib/microshift/manifests/delete`.
2121
. Move the manifest file into one of the `delete` subdirectories under the configured manifests directory by running the following command:
2222
+
2323
[source,terminal]
2424
----
25-
$ [sudo] mv <path_of_manifests> <path_of_delete_directory> <1>
25+
$ [sudo] mv _<path_of_manifests>_ _<path_of_delete_directory>_ <1>
2626
----
27-
<1> Replace `_<path_of_manifests>_` with the path of the manifest to be deleted, for example, `/etc/microshift/manifests.d/010-SOME-MANIFEST`. Replace `_<path_of_delete_directory>_` with one of the following valid directory paths: `/etc/microshift/manifests.d/delete`, `/etc/microshift/manifests/delete`, `/usr/lib/microshift/manifests.d/delete` or `/usr/lib/microshift/manifests/delete`.
27+
<1> Replace `_<path_of_manifests>_` with the path of the manifest to be deleted, for example, `/etc/microshift/manifests.d/010-SOME-MANIFEST`. Replace `_<path_of_delete_directory>_` with the path of the delete subdirectory, for example, `/etc/microshift/manifests.d/delete`, `/etc/microshift/manifests/delete`, `/usr/lib/microshift/manifests.d/delete` or `/usr/lib/microshift/manifests/delete`.
2828
. Restart {microshift-short} by running the following command:
2929
+
3030
[source,terminal]

modules/microshift-manifests-upgrade-scenario-ostree.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Use the following procedure to remove some resources while retaining others to p
1010

1111
[IMPORTANT]
1212
====
13-
For OSTree systems, the `delete` subdirectories are read-only.
13+
For OSTree systems, the `delete` subdirectories are read only.
1414
====
1515

1616
.Procedure
1717

1818
. Identify the manifest that needs updating.
19-
. Create a new manifest to apply in the manifest directories. See link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift#microshift-applying-manifests-example_applications-microshift[Using manifests example] to create new manifests using the example.
19+
. Create a new manifest to apply in the manifest path. See link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift#microshift-applying-manifests-example_applications-microshift[Using manifests example] to create new manifests using the example.
2020
. Create a new manifest for resource deletion to be placed in the `delete` subdirectories.
2121
. Use the procedure in "Removing manifests for OSTree systems" to remove the manifests.

modules/microshift-manifests-upgrade-scenario-rpm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ Use the following procedure to remove some resources while retaining others to p
1111
.Procedure
1212

1313
. Identify the manifest that requires updating.
14-
. Create new manifests to be applied in the manifest directories.
14+
. Create new manifests to be applied in the manifest path.
1515
. Create new manifests for resource deletion. It is not necessary to include the `spec` in these manifests. See link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift#microshift-applying-manifests-example_applications-microshift[Using manifests example] to create new manifests using the example.
1616
. Use the procedure in "Removing manifests for RPM systems" to create `delete` subdirectories and place the manifests created for resource deletion in this path.

0 commit comments

Comments
 (0)