From 47e6898b32d858ae689374450bdf55491e5c3dd9 Mon Sep 17 00:00:00 2001 From: Bonrob2 <59453630+Bonrob2@users.noreply.github.com> Date: Fri, 17 Nov 2023 14:05:00 -0500 Subject: [PATCH] No Jira Fixed a typo and minor stylistic updates to the readme file. --- horizon/README.md.gotmpl | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/horizon/README.md.gotmpl b/horizon/README.md.gotmpl index 352e959..3ce9873 100644 --- a/horizon/README.md.gotmpl +++ b/horizon/README.md.gotmpl @@ -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 we be copied. +Provide one or more plain files (text and/or binary) in the ConfigMap and specify the directory where these files wil be copied. Here is a configuration example: @@ -83,13 +83,13 @@ kubectl create configmap -n $instance $configmap --from-file=lots-of-zeros.zip ### Overlay ConfigMap Notes -1. This mechanism can only be used 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 sub-directories. -3. ConfigMaps can't be larger than 1 MB (see the note [here](https://kubernetes.io/docs/concepts/configuration/configmap/#motivation). If you have more content, it will need to be split across multiple ConfigMaps or compressed into ZIP files. +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. +3. ConfigMaps can't be larger than 1 MB (see the note [here](https://kubernetes.io/docs/concepts/configuration/configmap/#motivation). If you have more content, you will need to split it across multiple ConfigMaps or compressed into ZIP files. 4. Use `kubectl delete configmap -n $instance $configmap` to delete an existing ConfigMap before updating. -5. After updating a ConfigMap, you will need to restart the pod, for example: `kubectl rollout restart -n $instance statefulset/onms-core` +5. After updating a ConfigMap, you will need to restart the pod; for example, `kubectl rollout restart -n $instance statefulset/onms-core` 6. You can use `kubectl get configmap -n $instance $configmap -o yaml` to view the ConfigMap that is created. -7. Due to file ownership, some files/directories might not be updatable in the container at runtime. A workaround is to build a modified container that updates permissions with `chmod -R g=u ...` on the affected files/directories. See the OpenNMS [core Dockerfile](https://github.com/OpenNMS/opennms/blob/develop/opennms-container/core/Dockerfile) for which directories have been updated to allow writes out-of-the-box. +7. Due to file ownership, some files/directories might not be updatable in the container at runtime. A workaround is to build a modified container that updates permissions with `chmod -R g=u ...` on the affected files/directories. See the OpenNMS [core Dockerfile](https://github.com/OpenNMS/opennms/blob/develop/opennms-container/core/Dockerfile) for which directories have been updated to allow writes out of the box. {{ template "chart.valuesSection" . }}