From 595df0ea8327fa79f6b35867b14b0b957d09e123 Mon Sep 17 00:00:00 2001 From: nniehoff Date: Mon, 13 Sep 2021 07:36:13 -0600 Subject: [PATCH] Adding README --- charts/nautobot/README.md | 265 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 charts/nautobot/README.md diff --git a/charts/nautobot/README.md b/charts/nautobot/README.md new file mode 100644 index 00000000..04464220 --- /dev/null +++ b/charts/nautobot/README.md @@ -0,0 +1,265 @@ +# nautobot + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: 1.1.2](https://img.shields.io/badge/AppVersion-1.1.2-informational?style=flat-square) + +Nautobot is a Network Source of Truth and Network Automation Platform. + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Network to Code | opensource@networktocode.com | | + +## Source Code + +* +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | common | 1.x.x | +| https://charts.bitnami.com/bitnami | postgresql | 10.x.x | +| https://charts.bitnami.com/bitnami | redis | 14.X.X | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| autoscaling.apiVersion | string | `"autoscaling/v2beta2"` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `5` | | +| autoscaling.metrics[0].resource.name | string | `"cpu"` | | +| autoscaling.metrics[0].resource.targetAverageUtilization | int | `80` | | +| autoscaling.metrics[0].type | string | `"Resource"` | | +| autoscaling.minReplicas | int | `2` | | +| celeryWorker.affinity | object | `{}` | | +| celeryWorker.args[0] | string | `"nautobot-server"` | | +| celeryWorker.args[1] | string | `"celery"` | | +| celeryWorker.args[2] | string | `"worker"` | | +| celeryWorker.args[3] | string | `"--loglevel"` | | +| celeryWorker.args[4] | string | `"$(NAUTOBOT_LOG_LEVEL)"` | | +| celeryWorker.command | list | `[]` | | +| celeryWorker.containerSecurityContext.enabled | bool | `true` | | +| celeryWorker.containerSecurityContext.runAsUser | int | `999` | | +| celeryWorker.customLivenessProbe | object | `{}` | | +| celeryWorker.customReadinessProbe | object | `{}` | | +| celeryWorker.existingConfigmap | string | `nil` | | +| celeryWorker.extraEnvVars | list | `[]` | | +| celeryWorker.extraEnvVarsCM | string | `nil` | | +| celeryWorker.extraEnvVarsSecret | string | `nil` | | +| celeryWorker.extraVolumeMounts | list | `[]` | | +| celeryWorker.extraVolumes | list | `[]` | | +| celeryWorker.hostAliases | list | `[]` | | +| celeryWorker.initContainers | object | `{}` | | +| celeryWorker.lifecycleHooks | object | `{}` | | +| celeryWorker.livenessProbe.enabled | bool | `true` | | +| celeryWorker.livenessProbe.exec.command[0] | string | `"bash"` | | +| celeryWorker.livenessProbe.exec.command[1] | string | `"-c"` | | +| celeryWorker.livenessProbe.exec.command[2] | string | `"nautobot-server celery inspect ping --destination celery@$HOSTNAME"` | | +| celeryWorker.livenessProbe.failureThreshold | int | `3` | | +| celeryWorker.livenessProbe.initialDelaySeconds | int | `3` | | +| celeryWorker.livenessProbe.periodSeconds | int | `10` | | +| celeryWorker.livenessProbe.successThreshold | int | `1` | | +| celeryWorker.livenessProbe.timeoutSeconds | int | `5` | | +| celeryWorker.nodeAffinityPreset.key | string | `""` | | +| celeryWorker.nodeAffinityPreset.type | string | `""` | | +| celeryWorker.nodeAffinityPreset.values | list | `[]` | | +| celeryWorker.nodeSelector | object | `{}` | | +| celeryWorker.podAffinityPreset | string | `""` | | +| celeryWorker.podAnnotations | object | `{}` | | +| celeryWorker.podAntiAffinityPreset | string | `"soft"` | | +| celeryWorker.podLabels | object | `{}` | | +| celeryWorker.podSecurityContext.enabled | bool | `true` | | +| celeryWorker.podSecurityContext.fsGroup | int | `999` | | +| celeryWorker.priorityClassName | string | `""` | | +| celeryWorker.readinessProbe.enabled | bool | `true` | | +| celeryWorker.readinessProbe.exec.command[0] | string | `"bash"` | | +| celeryWorker.readinessProbe.exec.command[1] | string | `"-c"` | | +| celeryWorker.readinessProbe.exec.command[2] | string | `"nautobot-server celery inspect ping --destination celery@$HOSTNAME"` | | +| celeryWorker.readinessProbe.failureThreshold | int | `3` | | +| celeryWorker.readinessProbe.initialDelaySeconds | int | `30` | | +| celeryWorker.readinessProbe.periodSeconds | int | `10` | | +| celeryWorker.readinessProbe.successThreshold | int | `1` | | +| celeryWorker.readinessProbe.timeoutSeconds | int | `5` | | +| celeryWorker.replicaCount | int | `2` | | +| celeryWorker.resources.limits.cpu | string | `"1"` | | +| celeryWorker.resources.limits.memory | string | `"1Gi"` | | +| celeryWorker.resources.requests.cpu | string | `".1"` | | +| celeryWorker.resources.requests.memory | string | `"512Mi"` | | +| celeryWorker.sidecars | object | `{}` | | +| celeryWorker.tolerations | list | `[]` | | +| celeryWorker.updateStrategy.type | string | `"RollingUpdate"` | | +| ingress.annotations | object | `{}` | | +| ingress.apiVersion | string | `nil` | | +| ingress.certManager | bool | `false` | | +| ingress.enabled | bool | `false` | | +| ingress.hostname | string | `"nautobot.local"` | | +| ingress.path | string | `"/"` | | +| ingress.pathType | string | `"ImplementationSpecific"` | | +| ingress.secrets | list | `[]` | | +| ingress.tls | bool | `false` | | +| nautobot.affinity | object | `{}` | | +| nautobot.args[0] | string | `"nautobot-server"` | | +| nautobot.args[1] | string | `"start"` | | +| nautobot.args[2] | string | `"--ini"` | | +| nautobot.args[3] | string | `"/opt/nautobot/uwsgi.ini"` | | +| nautobot.command | list | `[]` | | +| nautobot.containerSecurityContext.enabled | bool | `true` | | +| nautobot.containerSecurityContext.runAsGroup | int | `999` | | +| nautobot.containerSecurityContext.runAsUser | int | `999` | | +| nautobot.customLivenessProbe | object | `{}` | | +| nautobot.customReadinessProbe | object | `{}` | | +| nautobot.envVars.allowedHosts | string | `"*"` | | +| nautobot.envVars.dbEngine | string | `"django.db.backends.postgresql"` | | +| nautobot.envVars.dbHost | string | `"postgres"` | | +| nautobot.envVars.dbName | string | `"nautobot"` | | +| nautobot.envVars.dbPassword | string | `""` | | +| nautobot.envVars.dbPort | string | `""` | | +| nautobot.envVars.dbTimeout | string | `"300"` | | +| nautobot.envVars.dbUser | string | `"nautobot"` | | +| nautobot.envVars.debug | string | `"False"` | | +| nautobot.envVars.logLevel | string | `"INFO"` | | +| nautobot.envVars.metrics | string | `"True"` | | +| nautobot.envVars.redisHost | string | `""` | | +| nautobot.envVars.redisPassword | string | `""` | | +| nautobot.envVars.redisPort | string | `"6379"` | | +| nautobot.envVars.redisSSL | string | `"False"` | | +| nautobot.envVars.redisUsername | string | `""` | | +| nautobot.existingConfigmap | string | `nil` | | +| nautobot.extraEnvVars | list | `[]` | | +| nautobot.extraEnvVarsCM | string | `nil` | | +| nautobot.extraEnvVarsSecret | string | `nil` | | +| nautobot.extraVolumeMounts | list | `[]` | | +| nautobot.extraVolumes | list | `[]` | | +| nautobot.hostAliases | list | `[]` | | +| nautobot.image.debug | bool | `false` | | +| nautobot.image.pullPolicy | string | `"IfNotPresent"` | | +| nautobot.image.pullSecrets | list | `[]` | | +| nautobot.image.registry | string | `"ghcr.io"` | | +| nautobot.image.repository | string | `"nautobot/nautobot"` | | +| nautobot.image.tag | string | `"1.1.2"` | | +| nautobot.initContainers | object | `{}` | | +| nautobot.lifecycleHooks | object | `{}` | | +| nautobot.livenessProbe.enabled | bool | `true` | | +| nautobot.livenessProbe.failureThreshold | int | `3` | | +| nautobot.livenessProbe.httpGet.path | string | `"/health/"` | | +| nautobot.livenessProbe.httpGet.port | string | `"http"` | | +| nautobot.livenessProbe.initialDelaySeconds | int | `30` | | +| nautobot.livenessProbe.periodSeconds | int | `10` | | +| nautobot.livenessProbe.successThreshold | int | `1` | | +| nautobot.livenessProbe.timeoutSeconds | int | `5` | | +| nautobot.nodeAffinityPreset.key | string | `""` | | +| nautobot.nodeAffinityPreset.type | string | `""` | | +| nautobot.nodeAffinityPreset.values | list | `[]` | | +| nautobot.nodeSelector | object | `{}` | | +| nautobot.podAffinityPreset | string | `""` | | +| nautobot.podAnnotations | object | `{}` | | +| nautobot.podAntiAffinityPreset | string | `"soft"` | | +| nautobot.podLabels | object | `{}` | | +| nautobot.podSecurityContext.enabled | bool | `true` | | +| nautobot.podSecurityContext.fsGroup | int | `999` | | +| nautobot.priorityClassName | string | `""` | | +| nautobot.readinessProbe.enabled | bool | `true` | | +| nautobot.readinessProbe.failureThreshold | int | `3` | | +| nautobot.readinessProbe.httpGet.path | string | `"/health/"` | | +| nautobot.readinessProbe.httpGet.port | string | `"http"` | | +| nautobot.readinessProbe.initialDelaySeconds | int | `30` | | +| nautobot.readinessProbe.periodSeconds | int | `10` | | +| nautobot.readinessProbe.successThreshold | int | `1` | | +| nautobot.readinessProbe.timeoutSeconds | int | `5` | | +| nautobot.replicaCount | int | `2` | | +| nautobot.resources.limits.cpu | string | `"3"` | | +| nautobot.resources.limits.memory | string | `"2Gi"` | | +| nautobot.resources.requests.cpu | string | `"0.7"` | | +| nautobot.resources.requests.memory | string | `"784Mi"` | | +| nautobot.sidecars | object | `{}` | | +| nautobot.tolerations | list | `[]` | | +| nautobot.updateStrategy.type | string | `"RollingUpdate"` | | +| postgresql.enabled | bool | `true` | | +| postgresql.postgresqlDatabase | string | `"nautobot"` | | +| postgresql.postgresqlPassword | string | `"change-me"` | | +| postgresql.postgresqlUsername | string | `"nautobot"` | | +| rbac.create | bool | `false` | | +| redis.auth.enabled | bool | `true` | | +| redis.auth.password | string | `"change-me"` | | +| redis.enabled | bool | `true` | | +| rqWorker.affinity | object | `{}` | | +| rqWorker.args[0] | string | `"nautobot-server"` | | +| rqWorker.args[1] | string | `"rqworker"` | | +| rqWorker.command | list | `[]` | | +| rqWorker.containerSecurityContext.enabled | bool | `true` | | +| rqWorker.containerSecurityContext.runAsUser | int | `999` | | +| rqWorker.customLivenessProbe | object | `{}` | | +| rqWorker.customReadinessProbe | object | `{}` | | +| rqWorker.existingConfigmap | string | `nil` | | +| rqWorker.extraEnvVars | list | `[]` | | +| rqWorker.extraEnvVarsCM | string | `nil` | | +| rqWorker.extraEnvVarsSecret | string | `nil` | | +| rqWorker.extraVolumeMounts | list | `[]` | | +| rqWorker.extraVolumes | list | `[]` | | +| rqWorker.hostAliases | list | `[]` | | +| rqWorker.initContainers | object | `{}` | | +| rqWorker.lifecycleHooks | object | `{}` | | +| rqWorker.livenessProbe.enabled | bool | `true` | | +| rqWorker.livenessProbe.failureThreshold | int | `3` | | +| rqWorker.livenessProbe.httpGet.path | string | `"/"` | | +| rqWorker.livenessProbe.httpGet.port | int | `8001` | | +| rqWorker.livenessProbe.initialDelaySeconds | int | `3` | | +| rqWorker.livenessProbe.periodSeconds | int | `10` | | +| rqWorker.livenessProbe.successThreshold | int | `1` | | +| rqWorker.livenessProbe.timeoutSeconds | int | `5` | | +| rqWorker.nodeAffinityPreset.key | string | `""` | | +| rqWorker.nodeAffinityPreset.type | string | `""` | | +| rqWorker.nodeAffinityPreset.values | list | `[]` | | +| rqWorker.nodeSelector | object | `{}` | | +| rqWorker.podAffinityPreset | string | `""` | | +| rqWorker.podAnnotations | object | `{}` | | +| rqWorker.podAntiAffinityPreset | string | `"soft"` | | +| rqWorker.podLabels | object | `{}` | | +| rqWorker.podSecurityContext.enabled | bool | `true` | | +| rqWorker.podSecurityContext.fsGroup | int | `999` | | +| rqWorker.priorityClassName | string | `""` | | +| rqWorker.readinessProbe.enabled | bool | `true` | | +| rqWorker.readinessProbe.failureThreshold | int | `3` | | +| rqWorker.readinessProbe.httpGet.path | string | `"/"` | | +| rqWorker.readinessProbe.httpGet.port | int | `8001` | | +| rqWorker.readinessProbe.initialDelaySeconds | int | `3` | | +| rqWorker.readinessProbe.periodSeconds | int | `10` | | +| rqWorker.readinessProbe.successThreshold | int | `1` | | +| rqWorker.readinessProbe.timeoutSeconds | int | `5` | | +| rqWorker.replicaCount | int | `2` | | +| rqWorker.resources.limits.cpu | string | `"1"` | | +| rqWorker.resources.limits.memory | string | `"1Gi"` | | +| rqWorker.resources.requests.cpu | string | `".1"` | | +| rqWorker.resources.requests.memory | string | `"256Mi"` | | +| rqWorker.sidecars | object | `{}` | | +| rqWorker.tolerations | list | `[]` | | +| rqWorker.updateStrategy.type | string | `"RollingUpdate"` | | +| service.annotations | object | `{}` | | +| service.clusterIP | string | `nil` | | +| service.externalTrafficPolicy | string | `"Cluster"` | | +| service.httpsPort | int | `8443` | | +| service.loadBalancerIP | string | `nil` | | +| service.loadBalancerSourceRanges | list | `[]` | | +| service.nodePorts.http | string | `nil` | | +| service.nodePorts.https | string | `nil` | | +| service.port | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| volumePermissions.containerSecurityContext.runAsUser | int | `0` | | +| volumePermissions.enabled | bool | `false` | | +| volumePermissions.image.pullPolicy | string | `"Always"` | | +| volumePermissions.image.pullSecrets | list | `[]` | | +| volumePermissions.image.registry | string | `"docker.io"` | | +| volumePermissions.image.repository | string | `"bitnami/bitnami-shell"` | | +| volumePermissions.image.tag | string | `"10"` | | +| volumePermissions.resources.limits | object | `{}` | | +| volumePermissions.resources.requests | object | `{}` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)