Skip to content

Commit

Permalink
update docs based on review
Browse files Browse the repository at this point in the history
  • Loading branch information
gertzakis committed Jan 15, 2024
1 parent 866ca8b commit 30f41a8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions charts/nautobot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,11 +298,11 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th
| <a name="nautobot.nodeAffinityPreset.values">[nautobot.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L154)</a> | []string | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set |
| <a name="nautobot.nodeSelector">[nautobot.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L163)</a> | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot pods assignment |
| <a name="nautobot.pdb">[nautobot.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L109)</a> | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget |
| <a name="nautobot.persistence.accessMode">[nautobot.persistence.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L245)</a> | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) |
| <a name="nautobot.persistence.enabled">[nautobot.persistence.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L241)</a> | bool | `false` | - Enable PVC and the relevant volumes |
| <a name="nautobot.persistence.selector">[nautobot.persistence.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L249)</a> | object | `{}` | - |
| <a name="nautobot.persistence.size">[nautobot.persistence.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247)</a> | string | `"2Gi"` | - Persistent storage size request |
| <a name="nautobot.persistence.storageClass">[nautobot.persistence.storageClass](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243)</a> | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim |
| <a name="nautobot.persistenceStaticFiles.accessMode">[nautobot.persistenceStaticFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L245)</a> | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) |
| <a name="nautobot.persistenceStaticFiles.enabled">[nautobot.persistenceStaticFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L241)</a> | bool | `false` | - Enable PVC and the relevant volumes |
| <a name="nautobot.persistenceStaticFiles.selector">[nautobot.persistenceStaticFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L249)</a> | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim |
| <a name="nautobot.persistenceStaticFiles.size">[nautobot.persistenceStaticFiles.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247)</a> | string | `"1Gi"` | - Persistent storage size request |
| <a name="nautobot.persistenceStaticFiles.storageClassName">[nautobot.persistenceStaticFiles.storageClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243)</a> | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim |
| <a name="nautobot.podAffinityPreset">[nautobot.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L142)</a> | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` |
| <a name="nautobot.podAnnotations">[nautobot.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L140)</a> | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot pods |
| <a name="nautobot.podAntiAffinityPreset">[nautobot.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L144)</a> | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` |
Expand Down
10 changes: 5 additions & 5 deletions docs/configuration/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,11 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th
| <a name="nautobot.nodeAffinityPreset.values">[nautobot.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L154)</a> | []string | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set |
| <a name="nautobot.nodeSelector">[nautobot.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L163)</a> | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot pods assignment |
| <a name="nautobot.pdb">[nautobot.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L109)</a> | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget |
| <a name="nautobot.persistence.accessMode">[nautobot.persistence.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L245)</a> | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) |
| <a name="nautobot.persistence.enabled">[nautobot.persistence.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L241)</a> | bool | `false` | - Enable PVC and the relevant volumes |
| <a name="nautobot.persistence.selector">[nautobot.persistence.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L249)</a> | object | `{}` | - |
| <a name="nautobot.persistence.size">[nautobot.persistence.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247)</a> | string | `"2Gi"` | - Persistent storage size request |
| <a name="nautobot.persistence.storageClass">[nautobot.persistence.storageClass](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243)</a> | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim |
| <a name="nautobot.persistenceStaticFiles.accessMode">[nautobot.persistenceStaticFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L245)</a> | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) |
| <a name="nautobot.persistenceStaticFiles.enabled">[nautobot.persistenceStaticFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L241)</a> | bool | `false` | - Enable PVC and the relevant volumes |
| <a name="nautobot.persistenceStaticFiles.selector">[nautobot.persistenceStaticFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L249)</a> | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim |
| <a name="nautobot.persistenceStaticFiles.size">[nautobot.persistenceStaticFiles.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247)</a> | string | `"1Gi"` | - Persistent storage size request |
| <a name="nautobot.persistenceStaticFiles.storageClassName">[nautobot.persistenceStaticFiles.storageClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243)</a> | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim |
| <a name="nautobot.podAffinityPreset">[nautobot.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L142)</a> | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` |
| <a name="nautobot.podAnnotations">[nautobot.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L140)</a> | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot pods |
| <a name="nautobot.podAntiAffinityPreset">[nautobot.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L144)</a> | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` |
Expand Down

0 comments on commit 30f41a8

Please sign in to comment.