Skip to content

Commit

Permalink
Reflect changes in values and README
Browse files Browse the repository at this point in the history
  • Loading branch information
@LeoColomb
LeoColomb authored Jul 23, 2024
1 parent 9984925 commit 3523db7
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 7 deletions.
23 changes: 17 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ with Sentinel (e.g. using [Aaron Layfield](https://github.com/DandyDeveloper)'s
[redis-ha chart](https://github.com/DandyDeveloper/charts/tree/master/charts/redis-ha)).

Set `persistence.enabled` to `false` and use the S3 `storageBackend` and `storageConfig`
for object storage. This works well with Minio or Ceph RGW as well as Amazon S3.
for object storage. This works well with Minio or Ceph RGW as well as Amazon S3.
See [Persistent storage pitfalls](#persistent-storage-pitfalls), below.

Run multiple replicas of the NetBox web front-end to avoid interruptions during
Expand Down Expand Up @@ -185,8 +185,12 @@ The following table lists the configurable parameters for this chart and their d
| `metrics.enabled` | Expose Prometheus metrics at the `/metrics` HTTP endpoint | `false` |
| `metrics.serviceMonitor.enabled` | Whether to enable a [ServiceMonitor](https://prometheus-operator.dev/docs/operator/design/#servicemonitor) for Netbox | `false` |
| `metrics.serviceMonitor.additionalLabels` | Additonal labels to apply to the ServiceMonitor | `{}` |
| `metrics.serviceMonitor.interval` | Interval to scrape metrics. | `1m` |
| `metrics.serviceMonitor.scrapeTimeout` | Timeout duration for scraping metrics | `10s` |
| `metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions | `false` |
| `metrics.serviceMonitor.interval` | Interval at which metrics should be scraped | `""` |
| `metrics.serviceMonitor.scrapeTimeout` | Timeout duration for scraping metrics | `""` |
| `metrics.serviceMonitor.metricRelabelings` | Specify additional relabeling of metrics | `[]` |
| `metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` |
| `metrics.serviceMonitor.selector` | Prometheus instance selector labels | `{}` |
| `shortTimeFormat` | Django date format for short-form time strings | `"H:i:s"` |
| `dateTimeFormat` | Django date format for long-form date and time strings | `"N j, Y g:i a"` |
| `shortDateTimeFormat` | Django date format for short-form date and time strongs | `"Y-m-d H:i"` |
Expand Down Expand Up @@ -276,23 +280,30 @@ The following table lists the configurable parameters for this chart and their d
| `service.clusterIP` | The cluster IP address assigned to the service | `""` |
| `service.clusterIPs` | A list of cluster IP addresses assigned to the service | `[]` |
| `service.externalIPs` | A list of external IP addresses aliased to this service | `[]` |
| `service.externalTrafficPolicy` | Policy for routing external traffic | `""` |
| `service.externalTrafficPolicy` | Policy for routing external traffic | `Cluster` |
| `service.ipFamilyPolicy` | Represents the dual-stack-ness of the service | `""` |
| `service.loadBalancerIP` | Request a specific IP address when `service.type` is LoadBalancer | `""` |
| `service.loadBalancerSourceRanges` | A list of allowed IP ranges when `service.type` is LoadBalancer | `[]` |
| `service.loadBalancerIP` | Request a specific IP address when `service.type` is `LoadBalancer` | `""` |
| `service.loadBalancerSourceRanges` | A list of allowed IP ranges when `service.type` is `LoadBalancer` | `[]` |
| `service.loadBalancerClass` | Load Balancer class if `service.type` is `LoadBalancer` | `""` |
| `service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
| `ingress.enabled` | Create an `Ingress` resource for accessing NetBox | `false` |
| `ingress.className` | Use a named IngressClass | `""` |
| `ingress.annotations` | Extra annotations to apply to the `Ingress` resource | `{}` |
| `ingress.hosts` | List of hosts and paths to map to the service (see `values.yaml`) | `[{host:"chart-example.local",paths:["/"]}]` |
| `ingress.tls` | TLS settings for the `Ingress` resource | `[]` |
| `resources` | Configure resource requests or limits for NetBox | `{}` |
| `automountServiceAccountToken` | Whether to automatically mount the serviceAccount token in the main container or not | `false` |
| `priorityClassName` | Pods' priorityClassName | `""` |
| `schedulerName` | Name of the k8s scheduler (other than default) for pods | `""` |
| `terminationGracePeriodSeconds` | Seconds pods need to terminate gracefully | `""` |
| `topologySpreadConstraints` | Configure Pod Topology Spread Constraints for NetBox | `[]` |
| `readinessProbe.enabled` | Enable Kubernetes readinessProbe, see [readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes) | *see `values.yaml`* |
| `readinessProbe.initialDelaySeconds` | Number of seconds | *see `values.yaml`* |
| `readinessProbe.timeoutSeconds` | Number of seconds | *see `values.yaml`* |
| `readinessProbe.periodSeconds` | Number of seconds | *see `values.yaml`* |
| `readinessProbe.successThreshold` | Number of seconds | *see `values.yaml`* |
| `lifecycleHooks` | Automate configuration before or after container startup | `{}` |
| `init.image.repository` | Init container image repository | `busybox` |
| `init.image.tag` | Init container image tag | `1.32.1` |
| `init.image.pullPolicy` | Init container image pull policy | `IfNotPresent` |
Expand Down
69 changes: 68 additions & 1 deletion charts/netbox/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,17 @@ nodeSelector: {}
## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
##
tolerations: []
## @param priorityClassName Pods' priorityClassName
##
priorityClassName: ""
## @param schedulerName Name of the k8s scheduler (other than default) for pods
## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
##
schedulerName: ""
## @param terminationGracePeriodSeconds Seconds pods need to terminate gracefully
## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
##
terminationGracePeriodSeconds:
## @param topologySpreadConstraints Topology Spread Constraints for pod assignment
## https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
## The value is evaluated as a template.
Expand Down Expand Up @@ -742,6 +753,9 @@ readinessProbe:
periodSeconds: 10
failureThreshold: 3
successThreshold: 1
## @param lifecycleHooks for containers to automate configuration before or after startup
##
lifecycleHooks: {}
## @param extraEnvs Extra environment variables to be set on containers
## E.g:
## extraEnvs:
Expand All @@ -762,6 +776,7 @@ revisionHistoryLimit: 10
## @param service.type Kubernetes Service type
## @param service.loadBalancerSourceRanges Restricts access for LoadBalancer (only with `service.type: LoadBalancer`)
## @param service.loadBalancerIP loadBalancerIP for the service (optional, cloud specific)
## @param service.loadBalancerClass Load Balancer class (optional, cloud specific)
## @param service.nodePort Kubernetes node port
## @param service.externalTrafficPolicy Enable client source IP preservation
## @param service.clusterIP Service Cluster IP
Expand All @@ -782,9 +797,21 @@ service:
## - 0.0.0.0/0
##
loadBalancerSourceRanges: []
loadBalancerClass: ""
externalIPs: []
clusterIPs: []
ipFamilyPolicy: ""
## @param service.sessionAffinity Control where client requests go, to the same pod or round-robin
## Values: ClientIP or None
## ref: https://kubernetes.io/docs/concepts/services-networking/service/
##
sessionAffinity: None
## @param service.sessionAffinityConfig Additional settings for the sessionAffinity
## sessionAffinityConfig:
## clientIP:
## timeoutSeconds: 300
##
sessionAffinityConfig: {}

## Configure the ingress resource that allows you to access the app
## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/
Expand Down Expand Up @@ -849,6 +876,9 @@ metrics:
## @param metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
##
enabled: false
## @param metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
##
honorLabels: false
## @param metrics.serviceMonitor.interval Interval at which metrics should be scraped.
## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
## e.g:
Expand All @@ -861,6 +891,18 @@ metrics:
## scrapeTimeout: 10s
##
scrapeTimeout: ""
## @param metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
##
metricRelabelings: []
## @param metrics.serviceMonitor.relabelings Specify general relabeling
##
relabelings: []
## @param metrics.serviceMonitor.selector Prometheus instance selector labels
## ref: https://github.com/bitnami/charts/tree/main/bitnami/prometheus-operator#prometheus-configuration
## selector:
## prometheus: my-prometheus
##
selector: {}
additionalLabels: {}

## @section Databases parameters
Expand Down Expand Up @@ -1331,7 +1373,7 @@ worker:
automountServiceAccountToken: false
## @param worker.affinity Affinity for worker pod assignment
## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
##
affinity: {}
## @param worker.nodeSelector Node labels for worker pod assignment
Expand All @@ -1342,6 +1384,31 @@ worker:
## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
##
tolerations: []
## @param worker.priorityClassName Pods' priorityClassName
##
priorityClassName: ""
## @param worker.schedulerName Name of the k8s scheduler (other than default) for pods
## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
##
schedulerName: ""
## @param worker.terminationGracePeriodSeconds Seconds pods need to terminate gracefully
## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
##
terminationGracePeriodSeconds:
## @param worker.topologySpreadConstraints Topology Spread Constraints for pod assignment
## https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
## The value is evaluated as a template.
## e.g:
## topologySpreadConstraints:
## - maxSkew: 1
## topologyKey: topology.kubernetes.io/zone
## whenUnsatisfiable: DoNotSchedule
## labelSelector:
## matchLabels:
## "app.kubernetes.io/component": netbox
## "app.kubernetes.io/name": netbox
##
topologySpreadConstraints: []
## @param worker.hostAliases [array] Add deployment host aliases
## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
##
Expand Down

0 comments on commit 3523db7

Please sign in to comment.