Update configmap overlay doc #55
Open
Conversation
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
mmahacek
reviewed
Jan 26, 2024
| @@ -31,7 +31,7 @@ The chart supports specifying a list of ConfigMaps with `core.overlayConfigMaps` | |||
|
|
|||
| ### Plain files | |||
|
|
|||
| Provide one or more plain files (text and/or binary) in the ConfigMap and specify the directory where these files will be copied. | |||
| Provide one or more plain files (text and/or binary) in the ConfigMap and specify the directory where these files will be copied. Plain files does not recognize recursive directories due to ConfigMap restriction. See `Overlay ConfigMap Notes` item #2 for details. | |||
There was a problem hiding this comment.
Suggested change
| Provide one or more plain files (text and/or binary) in the ConfigMap and specify the directory where these files will be copied. Plain files does not recognize recursive directories due to ConfigMap restriction. See `Overlay ConfigMap Notes` item #2 for details. | |
| Provide one or more plain files (text and/or binary) in the ConfigMap and specify the directory where these files will be copied. | |
| Plain files does not recognize recursive directories due to ConfigMap restriction. | |
| See <<configmap-notes, Overlay ConfigMap Notes>> item #2 for details. |
| @@ -83,7 +83,7 @@ kubectl create configmap -n $instance $configmap --from-file=lots-of-zeros.zip | |||
| ### Overlay ConfigMap Notes | |||
|
|
|||
| 1. This mechanism can be used only to *add* files. When `etc` files are copied into the `onms-etc-pvc` PVC, removing a file from the ConfigMap will not cause the file in the PVC to be deleted. In this case, you will need to delete the file manually after updating the ConfigMap to remove the file. You can do this with `kubectl exec -n $instance onms-core-0 -- rm etc/testing-configmap`. | |||
| 2. ConfigMaps cannot contain recursive directory structures--only files. If you need to put files into multiple directories, each directory will need to be its own ConfigMap. `kubectl create configmap` will silently ignore subdirectories. | |||
| 2. ConfigMaps cannot contain recursive directory structures--only files. If you need to put files into multiple directories, each directory will need to be its own ConfigMap. `kubectl create configmap` will silently ignore subdirectories. A better alternative is ZIP files. | |||
There was a problem hiding this comment.
Suggested change
| 2. ConfigMaps cannot contain recursive directory structures--only files. If you need to put files into multiple directories, each directory will need to be its own ConfigMap. `kubectl create configmap` will silently ignore subdirectories. A better alternative is ZIP files. | |
| 2. ConfigMaps cannot contain recursive directory structures--only files. | |
| If you need to put files into multiple directories, each directory will need to be its own ConfigMap. `kubectl create configmap` will silently ignore subdirectories. | |
| ZIP files will create subdirectories when expanded. |
| @@ -83,7 +83,7 @@ kubectl create configmap -n $instance $configmap --from-file=lots-of-zeros.zip | |||
| ### Overlay ConfigMap Notes | |||
There was a problem hiding this comment.
Suggested change
| ### Overlay ConfigMap Notes | |
| [[configmap-notes]] | |
| ### Overlay ConfigMap Notes |
There was a problem hiding this comment.
Hmm that didn't work. Is that a markdown syntax?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add some clarification on configmap overlay restriction. This clarifies explicitly that Plains files cannot recognize recursive directories whereas Zip files is not subjected to that restriction.