-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OSDOCS-12183: adding how to delete manifests
- Loading branch information
Showing
4 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
microshift_running_apps/microshift-deleting-resource-manifests.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="microshift-deleting-resource-manifests"] | ||
= Deleting resource manifests | ||
include::_attributes/attributes-microshift.adoc[] | ||
:context: microshift-deleting-resource-manifests | ||
|
||
toc::[] | ||
|
||
{microshift-short} supports the deletion of resource manifests for the following use cases: | ||
|
||
* Data removal - when you need to completely remove resource from the cluster. | ||
* Upgrade - During an upgrade, some resources may need to be removed while retaining others to preserve data. | ||
Resource manifest deletion helps to manage the cluster resources efficiently by removing outdated objects while preserving necessary data. | ||
|
||
include::modules/microshift-examples-of-usecase.adoc[leveloffset=+1] | ||
|
||
include::modules/microshift-manifests-deletion-overview.adoc[leveloffset=+1] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * microshift//running_applications/microshift-deleting-resource-manifests.adoc | ||
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="microshift-examples-of-usecase_{context}"] | ||
= Use cases for resource manifest deletion | ||
|
||
Use the following procedure in the data removal scenario to completely delete the resources defined in the kustomize manifest file. | ||
|
||
.Procedure | ||
|
||
. Identify the Kustomization file that has to be placed in the `delete` sub directories. | ||
. Move the manifest file to be deleted into one of the `delete` subdirectories under the configured manifests directory by running the following command: | ||
+ | ||
[source,terminal] | ||
---- | ||
[sudo] mv /usr/lib/microshift/manifests.d/some-user-manifest /usr/lib/microshift/manifests.d/delete/some-user-manifest | ||
---- | ||
. {microshift-short} will automatically delete and remove the resource once the manifest file is placed in the `delete` sub directories. | ||
|
||
|
||
Use the following procedure in the upgrade scenario where some resources may need to be removed while retaining others to preserve data. | ||
|
||
.Procedure | ||
|
||
. . Identify the Kustomization file that has to be upgraded.It is not necessary to include the entire resource `spec` in the `delete` sub directories. | ||
. You can specify the metadata like `name` and `namespace`of the resource you want to remove in the `delete` sub directories. | ||
. {microshift-short} will automatically delete the specified object without affecting the related data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * microshift//running_applications/microshift-deleting-resource-manifests.adoc | ||
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="microshift-manifests-deletion-overview_{context}"] | ||
= How manifest deletion works | ||
|
||
By default, {microshift-short} expects to find deletion manifests in the `delete` subdirectories within the manifest path. When a manifest file is placed in the `delete` subdirectories, {microshift-short} will automatically handle the removal. Read through the following procedure to understand how manifest file deletion works in {microshift-short}. | ||
|
||
.Procedure | ||
|
||
. At every start, before applying the manifests, {microshift-short} scans the following `delete` sub directories within the configured manifests directory to identify the Kustomize manifest files that need to be deleted: | ||
|
||
* /usr/lib/microshift/manifests/delete | ||
* /usr/lib/microshift/manifests.d/delete/* | ||
* /etc/microshift/manifests/delete | ||
* /etc/microshift/manifests.d/delete/* | ||
. {microshift-short} then runs the following command to delete the resources defined in the kustomize manifest file found in the `delete` directories. | ||
+ | ||
[source,terminal] | ||
---- | ||
kubectl delete -k --ignore-not-found=true | ||
---- |