Skip to content

Update configmap overlay doc#55

Open
ProjectJYL wants to merge 1 commit intomainfrom
jylee/update-configmap-doc
Open

Update configmap overlay doc#55
ProjectJYL wants to merge 1 commit intomainfrom
jylee/update-configmap-doc

Conversation

@ProjectJYL
Copy link
Contributor

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.

Copy link
Contributor

@mmahacek mmahacek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will work for linking within the file, but you might need to test it.

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Overlay ConfigMap Notes
[[configmap-notes]]
### Overlay ConfigMap Notes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants