diff --git a/incubator/netbox/0.0.1/CHANGELOG.md b/incubator/netbox/0.0.1/CHANGELOG.md new file mode 100644 index 00000000000..0d4af959dde --- /dev/null +++ b/incubator/netbox/0.0.1/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + + + +## [netbox-0.0.1]netbox-0.0.1 (2022-11-10) + +### Feat + +- add netbox ([#4248](https://github.com/truecharts/charts/issues/4248)) + + \ No newline at end of file diff --git a/incubator/netbox/0.0.1/Chart.lock b/incubator/netbox/0.0.1/Chart.lock new file mode 100644 index 00000000000..ae729ad5600 --- /dev/null +++ b/incubator/netbox/0.0.1/Chart.lock @@ -0,0 +1,12 @@ +dependencies: +- name: common + repository: https://library-charts.truecharts.org + version: 10.9.4 +- name: postgresql + repository: https://charts.truecharts.org/ + version: 8.0.122 +- name: redis + repository: https://charts.truecharts.org + version: 3.0.121 +digest: sha256:3d735a35d0b9723ef7c9fab29613f5407c530ac80815a2f5f9d9673ba25da2f6 +generated: "2022-11-10T15:07:38.772854797Z" diff --git a/incubator/netbox/0.0.1/Chart.yaml b/incubator/netbox/0.0.1/Chart.yaml new file mode 100644 index 00000000000..c83fd8854b8 --- /dev/null +++ b/incubator/netbox/0.0.1/Chart.yaml @@ -0,0 +1,35 @@ +apiVersion: v2 +appVersion: "3.3.6" +dependencies: + - name: common + repository: https://library-charts.truecharts.org + version: 10.9.4 + - condition: postgresql.enabled + name: postgresql + repository: https://charts.truecharts.org/ + version: 8.0.122 + - condition: redis.enabled + name: redis + repository: https://charts.truecharts.org + version: 3.0.121 +description: NetBox is the leading solution for modeling and documenting modern networks. +home: https://truecharts.org/docs/charts/incubator/netbox +icon: https://truecharts.org/img/hotlink-ok/chart-icons/netbox.png +keywords: + - network + - netbox +kubeVersion: ">=1.16.0-0" +maintainers: + - email: info@truecharts.org + name: TrueCharts + url: https://truecharts.org +name: netbox +sources: + - https://github.com/truecharts/charts/tree/master/charts/incubator/netbox + - https://github.com/netbox-community/netbox-docker +version: 0.0.1 +annotations: + truecharts.org/catagories: | + - network + truecharts.org/SCALE-support: "true" + truecharts.org/grade: U diff --git a/incubator/netbox/0.0.1/README.md b/incubator/netbox/0.0.1/README.md new file mode 100644 index 00000000000..e3a0b100e36 --- /dev/null +++ b/incubator/netbox/0.0.1/README.md @@ -0,0 +1,108 @@ +# netbox + +NetBox is the leading solution for modeling and documenting modern networks. + +TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE. + +This readme is just an automatically generated general guide on installing our Helm Charts and Apps. +For more information, please click here: [netbox](https://truecharts.org/docs/charts/incubator/netbox) + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)** + +## Source Code + +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.truecharts.org/ | postgresql | 8.0.122 | +| https://charts.truecharts.org | redis | 3.0.121 | +| https://library-charts.truecharts.org | common | 10.9.4 | + +## Installing the Chart + +### TrueNAS SCALE + +To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App). + +### Helm + +To install the chart with the release name `netbox` + +```console +helm repo add TrueCharts https://charts.truecharts.org +helm repo update +helm install netbox TrueCharts/netbox +``` + +## Uninstall + +### TrueNAS SCALE + +**Upgrading, Rolling Back and Uninstalling the Chart** + +To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App). + +### Helm + +To uninstall the `netbox` deployment + +```console +helm uninstall netbox +``` + +## Configuration + +### Helm + +#### Available Settings + +Read through the values.yaml file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/truecharts/library-charts/tree/main/charts/common). + +#### Configure using the command line + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install netbox \ + --set env.TZ="America/New York" \ + TrueCharts/netbox +``` + +#### Configure using a yaml file + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install netbox TrueCharts/netbox -f values.yaml +``` + +#### Connecting to other charts + +If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/linking-apps) quick-start guide. + +## Support + +- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Important-MUST-READ). +- See the [Website](https://truecharts.org) +- Check our [Discord](https://discord.gg/tVsPTHWTtr) +- Open a [issue](https://github.com/truecharts/apps/issues/new/choose) + +--- + +## Sponsor TrueCharts + +TrueCharts can only exist due to the incredible effort of our staff. +Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can! + +--- + +All Rights Reserved - The TrueCharts Project diff --git a/incubator/netbox/0.0.1/app-readme.md b/incubator/netbox/0.0.1/app-readme.md new file mode 100644 index 00000000000..35163b5207a --- /dev/null +++ b/incubator/netbox/0.0.1/app-readme.md @@ -0,0 +1,8 @@ +NetBox is the leading solution for modeling and documenting modern networks. + +This App is supplied by TrueCharts, for more information visit the manual: [https://truecharts.org/docs/charts/incubator/netbox](https://truecharts.org/docs/charts/incubator/netbox) + +--- + +TrueCharts can only exist due to the incredible effort of our staff. +Please consider making a [donation](https://truecharts.org/docs/about/sponsor) or contributing back to the project any way you can! diff --git a/incubator/netbox/0.0.1/charts/common-10.9.4.tgz b/incubator/netbox/0.0.1/charts/common-10.9.4.tgz new file mode 100644 index 00000000000..aa605d254d8 Binary files /dev/null and b/incubator/netbox/0.0.1/charts/common-10.9.4.tgz differ diff --git a/incubator/netbox/0.0.1/charts/postgresql-8.0.122.tgz b/incubator/netbox/0.0.1/charts/postgresql-8.0.122.tgz new file mode 100644 index 00000000000..a663db2e6c1 Binary files /dev/null and b/incubator/netbox/0.0.1/charts/postgresql-8.0.122.tgz differ diff --git a/incubator/netbox/0.0.1/charts/redis-3.0.121.tgz b/incubator/netbox/0.0.1/charts/redis-3.0.121.tgz new file mode 100644 index 00000000000..c8d0d90c105 Binary files /dev/null and b/incubator/netbox/0.0.1/charts/redis-3.0.121.tgz differ diff --git a/incubator/netbox/0.0.1/ix_values.yaml b/incubator/netbox/0.0.1/ix_values.yaml new file mode 100644 index 00000000000..5d14e4cf7ec --- /dev/null +++ b/incubator/netbox/0.0.1/ix_values.yaml @@ -0,0 +1,268 @@ +image: + repository: tccr.io/truecharts/netbox + tag: 3.3.6@sha256:4084b61c588dd2f15d117f30017a5c15fd03c3de38ed49e3241c48bce54048d7 + pullPolicy: IfNotPresent + +securityContext: + readOnlyRootFilesystem: false + runAsNonRoot: false + +podSecurityContext: + runAsUser: 0 + runAsGroup: 0 + +probes: + liveness: + type: HTTP + path: /login + readiness: + type: HTTP + path: /login + startup: + type: HTTP + path: /login + # Gives some time for app to run db migrations + initialDelaySeconds: 60 + +service: + main: + ports: + main: + port: 10265 + protocol: HTTP + targetPort: 8080 + +netbox: + # -- This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write + # access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. + # 127.0.0.1 added automatically + allowed_hosts: + [] + # - netbox.example.com + # - URL schemes that are allowed within links in NetBox + allowed_urls_schemes: + [] + # - file + # - ftp + # -- Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of + # application errors (assuming correct email settings are provided). + admins: + [] + # - name: John Doe + # email: jdoe@example.com + # -- Enable any desired validators for local account passwords below. For a list of included validators, please see the + # Django documentation at https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation. + auth_password_validators: + [] + # - name: django.contrib.auth.password_validation.MinimumLengthValidator + # options: + # - key: min_length + # value: 10 + banner: + # -- Optionally display a persistent banner at the top of every page. + top: "" + # -- Optionally display a persistent banner at the bottom of every page. + bottom: "" + # -- Text to include on the login page above the login form. HTML is allowed + login: "" + retention: + # -- Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. + changelog: 90 + # -- Maximum number of days to retain job results (scripts and reports). Set to 0 to retain job results in the database indefinitely. + job_result: 90 + # -- When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. + prefer_ipv4: false + # -- Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table + enforce_global_unique: true + # - API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be + # - allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or + # - CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers + cors_origin_allow_all: false + cors_origin_whitelist: + [] + # - "127.0.0.1" + cors_origin_regex_whitelist: + [] + # - r'^(https?://)?(\w+\.)?example\.com$' + debug: false + email: + server: "" + port: 587 + username: "" + password: "" + use_ssl: false + use_tls: true + timeout: 10 + from_email: "" + # -- Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and + # by anonymous users. List models in the form `.`. Add '*' to this list to exempt all models. + exempt_view_permissions: + [] + # - dcim.site + # - dcim.region + # - ipam.prefix + # - HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks). + http_proxies: + [] + # - key: http + # url: http://10.10.1.10:3128 + # - key: https + # url: http://10.10.1.10:1080 + # -- IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing + # NetBox from an internal IP. (127.0.0.1 and ::1) added automatically + internal_ips: + [] + # - "10.10.10.5" + # -- Automatically reset the lifetime of a valid session upon each authenticated request. Enables users to remain + # authenticated to NetBox indefinitely. + login_persistence: false + # -- Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users + # are permitted to access most data in NetBox but not make any changes. + login_required: true + # -- The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to + # re-authenticate. (Default: 1209600 [14 days]) + login_timeout: 1209600 + # -- Enable GraphQL API. + graphql_enabled: true + # -- Maps provider + maps_url: https://maps.google.com/?q= + # -- An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g. + # "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request + # all objects by specifying "?limit=0". + max_page_size: 1000 + # -- Determine how many objects to display per page within a list. (Default: 50) + paginate_count: 50 + powerfeed: + # -- The default value for the amperage field when creating new power feeds. + default_amperage: 15 + # -- The default value (percentage) for the max_utilization field when creating new power feeds. + default_max_utilization: 80 + # -- The default value for the voltage field when creating new power feeds. + default_voltage: 120 + # -- Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1. + rack: + elevation_default_unit_height: 22 + elevation_default_unit_width: 220 + # -- Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM. + napalm: + username: "" + password: "" + timeout: 30 + # -- NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). + args: + [] + # - arg: allow_agent + # value: "False" + # -- Cross-Site-Request-Forgery-Attack settings. If Netbox is sitting behind a reverse proxy, you might need to set this + csrf_trusted_origin: + [] + # - https://netbox.mydomain.com + # -- The name to use for the session cookie. + session_cookie_name: sessionid + # -- The name to use for the csrf token cookie. + csrf_cookie_name: csrftoken + # -- By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the + # class path of the storage driver in storage_backend and any configuration options in storage_config. For example: + # Example storages.backends.s3boto3.S3Boto3Storage + storage_backend: "" + storage_config: + [] + # - key: AWS_ACCESS_KEY_ID + # value: KeyID + # - key: AWS_SECRET_ACCESS_KEY + # value: Secret + # - key: AWS_STORAGE_BUCKET_NAME + # value: netbox + # - key: AWS_S3_REGION_NAME + # value: eu-west-1 + # -- Plugins configuration settings. These settings are used by various plugins that the user may have installed. + plugin_config: + # - plugin_name: plugin1 + # enabled: false + # config: + # - key: foo + # value: bar + # - key: fizz + # value: bizz + # -- Maximum execution time for background tasks, in seconds. + rq_default_timeout: 300 + # -- Remote authentication support + remote_auth: + {} + # enabled: false + # backend: netbox.authentication.RemoteUserBackend + # header: header + # auto_create_user: false + # default_groups: [] + # default_permissions: + # - key: dcim.change_site + # value: None + # -- Date/time formatting. See the following link for supported formats: + # https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date + date_time: + date_format: N j, Y + short_date_format: Y-m-d + time_format: g:i a + short_time_format: H:i:s + date_time_format: N j, Y g:i a + short_date_time_format: Y-m-d H:i + +metrics: + # -- Enable and configure a Prometheus serviceMonitor for the chart under this key. + # @default -- See values.yaml + enabled: false + serviceMonitor: + interval: 1m + scrapeTimeout: 30s + labels: {} + # -- Enable and configure Prometheus Rules for the chart under this key. + # @default -- See values.yaml + prometheusRule: + enabled: false + labels: {} + # -- Configure additionial rules for the chart under this key. + # @default -- See prometheusrules.yaml + rules: + [] + # - alert: UnifiPollerAbsent + # annotations: + # description: Unifi Poller has disappeared from Prometheus service discovery. + # summary: Unifi Poller is down. + # expr: | + # absent(up{job=~".*unifi-poller.*"} == 1) + # for: 5m + # labels: + # severity: critical + +persistence: + config: + enabled: true + mountPath: /etc/netbox/config + reports: + enabled: true + mountPath: /etc/netbox/reports + scripts: + enabled: true + mountPath: /etc/netbox/scripts + media: + enabled: true + mountPath: /opt/netbox/netbox/media + configfile: + enabled: true + type: secret + objectName: '{{ include "tc.common.names.fullname" . }}-secret' + mountPath: /etc/netbox/config/01-config.py + subPath: config.py + +postgresql: + enabled: true + existingSecret: dbcreds + postgresqlUsername: netbox + postgresqlDatabase: netbox + +redis: + enabled: true + existingSecret: rediscreds + +portal: + enabled: true diff --git a/incubator/netbox/0.0.1/questions.yaml b/incubator/netbox/0.0.1/questions.yaml new file mode 100644 index 00000000000..ddf7e7ba63f --- /dev/null +++ b/incubator/netbox/0.0.1/questions.yaml @@ -0,0 +1,3776 @@ +groups: + - name: Container Image + description: Image to be used for container + - name: Controller + description: Configure Workload Deployment + - name: Container Configuration + description: Additional Container Configuration + - name: App Configuration + description: App Specific Config Options + - name: Networking and Services + description: Configure Network and Services for Container + - name: Storage and Persistence + description: Persist and Share Data that is Separate from the Container + - name: Ingress + description: Ingress Configuration + - name: Security and Permissions + description: Configure Security Context and Permissions + - name: Resources and Devices + description: "Specify Resources/Devices to be Allocated to Workload" + - name: Middlewares + description: Traefik Middlewares + - name: Metrics + description: Metrics + - name: Addons + description: Addon Configuration + - name: Advanced + description: Advanced Configuration + - name: Documentation + description: Documentation +portals: + open: + protocols: + - "$kubernetes-resource_configmap_portal_protocol" + host: + - "$kubernetes-resource_configmap_portal_host" + ports: + - "$kubernetes-resource_configmap_portal_port" +questions: + - variable: global + label: Global Settings + group: Controller + schema: + type: dict + hidden: true + attrs: + - variable: isSCALE + label: Flag this is SCALE + schema: + type: boolean + default: true + hidden: true + - variable: controller + group: Controller + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: advanced + label: Show Advanced Controller Settings + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: type + description: Please specify type of workload to deploy + label: (Advanced) Controller Type + schema: + type: string + required: true + enum: + - value: deployment + description: Deployment + - value: statefulset + description: Statefulset + - value: daemonset + description: Daemonset + default: deployment + - variable: replicas + description: Number of desired pod replicas + label: Desired Replicas + schema: + type: int + required: true + default: 1 + - variable: strategy + description: Please specify type of workload to deploy + label: (Advanced) Update Strategy + schema: + type: string + required: true + enum: + - value: Recreate + description: "Recreate: Kill existing pods before creating new ones" + - value: RollingUpdate + description: "RollingUpdate: Create new pods and then kill old ones" + - value: OnDelete + description: "(Legacy) OnDelete: ignore .spec.template changes" + default: Recreate + - variable: expert + label: Show Expert Configuration Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Controller Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Controller Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: customextraargs + group: Controller + label: "Extra Args" + description: "Do not click this unless you know what you are doing" + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: extraArgs + label: Extra Args + schema: + type: list + default: [] + items: + - variable: arg + label: Arg + schema: + type: string + - variable: netbox + group: Container Configuration + label: Netbox Configuration + schema: + additional_attrs: true + type: dict + attrs: + - variable: allowed_hosts + label: Allowed Hosts + description: This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. (127.0.0.1 and ::1) added automatically + schema: + type: list + default: [] + items: + - variable: allowed_hosts_entry + label: Allowed Host + schema: + type: string + required: true + default: "" + - variable: allowed_urls_schemes + label: Allowed URL Schemes + description: URL schemes that are allowed within links in NetBox. + schema: + type: list + default: [] + items: + - variable: allowed_url_scheme_entry + label: Allowed URL Scheme + schema: + type: string + required: true + default: "" + - variable: admins + label: Admins + description: Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of application errors (assuming correct email settings are provided). + schema: + type: list + default: [] + items: + - variable: admin_entry + label: Admin + schema: + type: dict + additional_attrs: true + attrs: + - variable: name + label: Name + schema: + type: string + required: true + default: "" + - variable: email + label: Email + schema: + type: string + required: true + default: "" + - variable: auth_password_validators + label: Auth Password Validators + description: Enable any desired validators for local account passwords below. For a list of included validators, please see the Django documentation at https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation. + schema: + type: list + default: [] + items: + - variable: auth_password_validators_entry + label: Auth Password Validator + schema: + type: dict + additional_attrs: true + attrs: + - variable: name + label: Name + schema: + type: string + required: true + default: "" + - variable: options + label: Options + schema: + type: dict + additional_attrs: true + attrs: + - variable: key + label: Key + schema: + type: string + required: true + default: "" + - variable: value + label: Value + schema: + type: string + required: true + default: "" + - variable: banner + label: Banner + schema: + additional_attrs: true + type: dict + attrs: + - variable: login + label: Login Banner + description: Text to include on the login page above the login form. HTML is allowed + schema: + type: string + default: "" + - variable: top + label: Top Banner + description: Optionally display a persistent banner at the top of every page. + schema: + type: string + default: "" + - variable: bottom + label: Bottom Banner + description: Optionally display a persistent banner at the bottom of every page. + schema: + type: string + default: "" + - variable: retention + label: Retention + schema: + additional_attrs: true + type: dict + attrs: + - variable: changelog + label: Changelog + description: Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. + schema: + type: int + default: 90 + - variable: job_result + label: Job Results + description: Maximum number of days to retain job results (scripts and reports). Set to 0 to retain job results in the database indefinitely. + schema: + type: int + default: 90 + - variable: prefer_ipv4 + label: Prefer IPv4 + description: When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. + schema: + type: boolean + default: false + - variable: enforce_global_unique + label: Enforce Global Unique + description: Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table + schema: + type: boolean + default: true + - variable: cors_origin_allow_all + label: CORS Origin Allow All + description: If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers + schema: + type: boolean + default: false + show_subquestions_if: false + - variable: cors_origin_whitelist + label: CORS Origin Whitelist + description: Example 127.0.0.1 + schema: + type: list + default: [] + items: + - variable: cors_origin_whitelist_entry + label: CORS Origin Whitelist Entry + schema: + type: string + required: true + default: "" + - variable: cors_origin_regex_whitelist + label: CORS Origin Regex Whitelist + description: Example r'^(https?://)?(\w+\.)?example\.com$' + schema: + type: list + default: [] + items: + - variable: cors_origin_whitelist_entry + label: CORS Origin Regex Whitelist Entry + schema: + type: string + required: true + default: "" + - variable: csrf_trusted_origin + label: CSRF Trusted Origin + description: Cross-Site-Request-Forgery-Attack settings. If Netbox is sitting behind a reverse proxy, you might need to set this + schema: + type: list + default: [] + items: + - variable: csrf_trusted_origin_entry + label: CSRF Trusted Origin Entry + schema: + type: string + required: true + default: "" + - variable: csrf_cookie_name + label: CSRF Cookie Name + description: The name to use for the csrf token cookie. + schema: + type: string + default: csrftoken + - variable: session_cookie_name + label: Session Cookie Name + description: The name to use for the session cookie. + schema: + type: string + default: sessionid + - variable: email + label: Email + schema: + additional_attrs: true + type: dict + attrs: + - variable: server + label: Server + schema: + type: string + default: "" + - variable: port + label: Port + schema: + type: int + default: 587 + - variable: from_email + label: From Email + schema: + type: string + default: "" + - variable: username + label: Username + schema: + type: string + default: "" + - variable: password + label: Password + schema: + type: string + private: true + default: "" + - variable: use_ssl + label: Use SSL + schema: + type: boolean + default: false + - variable: use_tls + label: Use TLS + schema: + type: boolean + default: true + - variable: timeout + label: Timeout + schema: + type: int + default: 10 + - variable: exempt_view_permissions + label: Exempt View Permissions + description: Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and by anonymous users. List models in the form `.`. Add '*' to this list to exempt all models. + schema: + type: list + default: [] + items: + - variable: exempt_view_permissions_entry + label: Exempt View Permission + schema: + type: string + required: true + default: "" + - variable: http_proxies + label: HTTP Proxies + description: HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks). + schema: + type: list + default: [] + items: + - variable: http_proxy_entry + label: HTTP Proxy Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: key + label: Key + schema: + type: string + required: true + default: "" + - variable: url + label: URL + schema: + type: string + required: true + default: "" + - variable: internal_ips + label: Internal IPs + description: IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing NetBox from an internal IP. (127.0.0.1 and ::1) added automatically + schema: + type: list + default: [] + items: + - variable: internal_ips_entry + label: Internal IP + schema: + type: string + required: true + default: "" + - variable: login_persistence + label: Login Persistence + description: Automatically reset the lifetime of a valid session upon each authenticated request. Enables users to remain authenticated to NetBox indefinitely. + schema: + type: boolean + default: false + - variable: login_required + label: Login Required + description: Setting this to true will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox but not make any changes. + schema: + type: boolean + default: true + - variable: login_timeout + label: Login Timeout + description: The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to re-authenticate. + schema: + type: int + default: 1209600 + - variable: graphql_enabled + label: Enable GraphQL + description: Enable GraphQL API. + schema: + type: boolean + default: true + - variable: maps_url + label: Maps URl + description: Maps provider + schema: + type: string + default: https://maps.google.com/?q= + - variable: max_page_size + label: Max Page Size + description: This setting defines the maximum limit of objects an API can request. Setting it to 0 or None will allow an API consumer to request all objects. + schema: + type: int + default: 1000 + - variable: paginate_count + label: Paginate Count + description: Determine how many objects to display per page within a list. + schema: + type: int + default: 50 + - variable: powerfeed + label: Power Feed + schema: + additional_attrs: true + type: dict + attrs: + - variable: default_amperage + label: Default Amperage + description: The default value for the amperage field when creating new power feeds. + schema: + type: int + default: 15 + - variable: default_max_utilization + label: Default Max Utilization + description: The default value (percentage) for the max_utilization field when creating new power feeds. + schema: + type: int + default: 80 + - variable: default_voltage + label: Default Voltage + description: The default value for the voltage field when creating new power feeds. + schema: + type: int + default: 120 + - variable: rack + label: Rack + description: Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1. + schema: + additional_attrs: true + type: dict + attrs: + - variable: elevation_default_unit_height + label: Elevation Default Unit Height + schema: + type: int + default: 22 + - variable: elevation_default_unit_width + label: Elevation Default Unit Width + schema: + type: int + default: 220 + - variable: napalm + label: Napalm + description: Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM. + schema: + additional_attrs: true + type: dict + attrs: + - variable: username + label: Username + schema: + type: string + default: "" + - variable: password + label: Password + schema: + type: string + private: true + default: "" + - variable: timeout + label: Timeout + schema: + type: int + default: 30 + - variable: args + label: Args + description: NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). + schema: + type: list + default: [] + items: + - variable: arg_entry + label: Arg Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: arg + label: Arg + schema: + type: string + required: true + default: "" + - variable: value + label: Value + schema: + type: string + required: true + default: "" + - variable: storage_backend + label: Storage Backend + description: By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the class path of the storage driver in storage_backend and any configuration options in storage_config. + schema: + type: string + required: true + default: "" + - variable: storage_config + label: Storage Config + schema: + show_if: [["storage_backend", "!=", ""]] + type: list + default: [] + items: + - variable: storage_config_entry + label: Storage Config Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: key + label: Key + schema: + type: string + required: true + default: "" + - variable: value + label: Value + schema: + type: string + required: true + default: "" + - variable: rq_default_timeout + label: RQ Default Timeout + description: Maximum execution time for background tasks, in seconds. + schema: + type: int + required: true + default: 300 + - variable: remote_auth + label: Remote Auth + description: Remote authentication support + schema: + type: dict + additional_attrs: true + attrs: + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + - variable: backend + label: Backend + schema: + type: string + required: true + default: "" + - variable: header + label: Header + schema: + type: string + required: true + default: "" + - variable: auto_create_user + label: Auto Create User + schema: + type: boolean + default: false + - variable: default_groups + label: Default Groups + schema: + type: list + default: [] + items: + - variable: default_group_entry + label: Default Group + schema: + type: string + required: true + default: "" + - variable: default_permissions + label: Default Permissions + schema: + type: list + default: [] + items: + - variable: default_permissions_entry + label: Default Permission Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: key + label: Key + schema: + type: string + required: true + default: "" + - variable: value + label: Value + schema: + type: string + required: true + default: "" + - variable: date_time + label: Date Time + description: Date/time formatting. See the following link for supported formats https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date + schema: + type: dict + additional_attrs: true + attrs: + - variable: date_format + label: Date Format + schema: + type: string + required: true + default: N j, Y + - variable: short_date_format + label: Short Date Format + schema: + type: string + required: true + default: Y-m-d + - variable: time_format + label: Time Format + schema: + type: string + required: true + default: g:i a + - variable: short_time_format + label: Short Time Format + schema: + type: string + required: true + default: H:i:s + - variable: date_time_format + label: Date Time Format + schema: + type: string + required: true + default: N j, Y g:i a + - variable: short_date_time_format + label: Short Date Time Format + schema: + type: string + required: true + default: Y-m-d H:i + - variable: plugins_config + label: Plugins Config + description: Plugins configuration settings. These settings are used by various plugins that the user may have installed. + schema: + type: list + default: [] + items: + - variable: plugin_entry + label: Plugin Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: plugin_name + label: Plugin Name + schema: + type: string + required: true + default: "" + - variable: enabled + label: Enable Plugin + schema: + type: boolean + default: true + - variable: config + label: Config + schema: + type: list + default: [] + items: + - variable: config_entry + label: Config Entry + schema: + type: dict + additional_attrs: true + attrs: + - variable: key + label: Key + schema: + type: string + required: true + default: "" + - variable: value + label: Value + schema: + type: string + required: true + default: "" + - variable: TZ + label: Timezone + group: Container Configuration + schema: + type: string + default: "Etc/UTC" + $ref: + - "definitions/timezone" + - variable: envList + label: Extra Environment Variables + description: "Please be aware that some variables are set in the background, adding duplicates here might cause issues or prevent the app from starting..." + group: Container Configuration + schema: + type: list + default: [] + items: + - variable: envItem + label: Environment Variable + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: expertpodconf + group: Container Configuration + label: Show Expert Configuration + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: tty + label: Enable TTY + description: Determines whether containers in a pod runs with TTY enabled. By default pod has it disabled. + group: Workload Details + schema: + type: boolean + default: false + - variable: stdin + label: Enable STDIN + description: Determines whether containers in a pod runs with stdin enabled. By default pod has it disabled. + group: Workload Details + schema: + type: boolean + default: false + - variable: termination + group: Container Configuration + label: Termination settings + schema: + additional_attrs: true + type: dict + attrs: + - variable: gracePeriodSeconds + label: Grace Period Seconds + schema: + type: int + default: 10 + - variable: podLabelsList + group: Container Configuration + label: Pod Labels + schema: + type: list + default: [] + items: + - variable: podLabelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: podAnnotationsList + group: Container Configuration + label: Pod Annotations + schema: + type: list + default: [] + items: + - variable: podAnnotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: service + group: Networking and Services + label: Configure Service(s) + schema: + additional_attrs: true + type: dict + attrs: + - variable: main + label: Main Service + description: The Primary service on which the healthcheck runs, often the webUI + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable the Service + schema: + type: boolean + default: true + hidden: true + - variable: type + label: Service Type + description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer" + schema: + type: string + default: LoadBalancer + enum: + - value: LoadBalancer + description: LoadBalancer (Expose Ports) + - value: ClusterIP + description: ClusterIP (Do Not Expose Ports) + - value: Simple + description: Deprecated CHANGE THIS + - variable: loadBalancerIP + label: LoadBalancer IP + description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB" + schema: + show_if: [["type", "=", "LoadBalancer"]] + type: string + default: "" + - variable: advancedsvcset + label: Show Advanced Service Settings + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: externalIPs + label: "External IP's" + description: "External IP's" + schema: + type: list + default: [] + items: + - variable: externalIP + label: External IP + schema: + type: string + - variable: ipFamilyPolicy + label: IP Family Policy + description: Specify the IP Policy + schema: + type: string + default: SingleStack + enum: + - value: SingleStack + description: SingleStack + - value: PreferDualStack + description: PreferDualStack + - value: RequireDualStack + description: RequireDualStack + - variable: ipFamilies + label: IP Families + description: The IP Families that should be used + schema: + type: list + default: [] + items: + - variable: ipFamily + label: IP Family + schema: + type: string + - variable: ports + label: "Service's Port(s) Configuration" + schema: + additional_attrs: true + type: dict + attrs: + - variable: main + label: Main Service Port Configuration + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: Port + description: This port exposes the container port on the service + schema: + type: int + default: 10265 + required: true + - variable: advanced + label: Show Advanced Settings + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: enabled + label: Enable the Port + schema: + type: boolean + hidden: true + default: true + - variable: protocol + label: Port Type + schema: + type: string + default: HTTP + enum: + - value: HTTP + description: HTTP + - value: HTTPS + description: HTTPS + - value: TCP + description: TCP + - value: UDP + description: UDP + - variable: nodePort + label: Node Port (Optional) + description: This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer + schema: + type: int + min: 9000 + max: 65535 + - variable: targetPort + label: Target Port + description: The internal(!) port on the container the Application runs on + schema: + type: int + default: 8080 + - variable: serviceexpert + group: Networking and Services + label: Show Expert Config + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: hostNetwork + group: Networking and Services + label: Host-Networking (Complicated) + schema: + type: boolean + default: false + - variable: externalInterfaces + description: Add External Interfaces + label: Add external Interfaces + group: Networking + schema: + type: list + items: + - variable: interfaceConfiguration + description: Interface Configuration + label: Interface Configuration + schema: + type: dict + $ref: + - "normalize/interfaceConfiguration" + attrs: + - variable: hostInterface + description: Please Specify Host Interface + label: Host Interface + schema: + type: string + required: true + $ref: + - "definitions/interface" + - variable: ipam + description: Define how IP Address will be managed + label: IP Address Management + schema: + type: dict + required: true + attrs: + - variable: type + description: Specify type for IPAM + label: IPAM Type + schema: + type: string + required: true + enum: + - value: dhcp + description: Use DHCP + - value: static + description: Use Static IP + show_subquestions_if: static + subquestions: + - variable: staticIPConfigurations + label: Static IP Addresses + schema: + type: list + items: + - variable: staticIP + label: Static IP + schema: + type: ipaddr + cidr: true + - variable: staticRoutes + label: Static Routes + schema: + type: list + items: + - variable: staticRouteConfiguration + label: Static Route Configuration + schema: + additional_attrs: true + type: dict + attrs: + - variable: destination + label: Destination + schema: + type: ipaddr + cidr: true + required: true + - variable: gateway + label: Gateway + schema: + type: ipaddr + cidr: false + required: true + - variable: dnsPolicy + group: Networking and Services + label: dnsPolicy + schema: + type: string + default: "" + enum: + - value: "" + description: Default + - value: ClusterFirst + description: ClusterFirst + - value: None + description: None + - variable: dnsConfig + label: DNS Configuration + group: Networking and Services + description: Specify custom DNS configuration which will be applied to the pod + schema: + additional_attrs: true + type: dict + attrs: + - variable: nameservers + label: Name Servers + schema: + default: [] + type: list + items: + - variable: nameserver + label: Name Server + schema: + type: string + - variable: options + label: Options + schema: + default: [] + type: list + items: + - variable: option + label: Option Entry + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: searches + label: Searches + schema: + default: [] + type: list + items: + - variable: search + label: Search Entry + schema: + type: string + - variable: serviceList + label: Add Manual Custom Services + group: Networking and Services + schema: + type: list + default: [] + items: + - variable: serviceListEntry + label: Custom Service + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable the service + schema: + type: boolean + default: true + hidden: true + - variable: name + label: Name + schema: + type: string + default: "" + - variable: type + label: Service Type + description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer" + schema: + type: string + default: LoadBalancer + enum: + - value: LoadBalancer + description: LoadBalancer (Expose Ports) + - value: ClusterIP + description: ClusterIP (Do Not Expose Ports) + - value: Simple + description: Deprecated CHANGE THIS + - variable: loadBalancerIP + label: LoadBalancer IP + description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB" + schema: + show_if: [["type", "=", "LoadBalancer"]] + type: string + default: "" + - variable: advancedsvcset + label: Show Advanced Service Settings + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: externalIPs + label: "External IP's" + description: "External IP's" + schema: + type: list + default: [] + items: + - variable: externalIP + label: External IP + schema: + type: string + - variable: ipFamilyPolicy + label: IP Family Policy + description: Specify the IP Policy + schema: + type: string + default: SingleStack + enum: + - value: SingleStack + description: SingleStack + - value: PreferDualStack + description: PreferDualStack + - value: RequireDualStack + description: RequireDualStack + - variable: ipFamilies + label: IP Families + description: (Advanced) The IP Families that should be used + schema: + type: list + default: [] + items: + - variable: ipFamily + label: IP Family + schema: + type: string + - variable: portsList + label: Additional Service Ports + schema: + type: list + default: [] + items: + - variable: portsListEntry + label: Custom ports + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable the Port + schema: + type: boolean + default: true + hidden: true + - variable: name + label: Port Name + schema: + type: string + default: "" + - variable: protocol + label: Port Type + schema: + type: string + default: TCP + enum: + - value: HTTP + description: HTTP + - value: HTTPS + description: HTTPS + - value: TCP + description: TCP + - value: UDP + description: UDP + - variable: targetPort + label: Target Port + description: This port exposes the container port on the service + schema: + type: int + required: true + - variable: port + label: Container Port + schema: + type: int + required: true + - variable: persistence + label: Integrated Persistent Storage + description: Integrated Persistent Storage + group: Storage and Persistence + schema: + additional_attrs: true + type: dict + attrs: + - variable: config + label: App Config Storage + description: Stores the Application Configuration. + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Type of Storage + description: Sets the persistence type, Anything other than PVC could break rollback! + schema: + type: string + default: simplePVC + enum: + - value: simplePVC + description: PVC (simple) + - value: simpleHP + description: Host Path (simple) + - value: emptyDir + description: emptyDir + - value: pvc + description: PVC + - value: hostPath + description: Host Path + - value: nfs + description: NFS Share + - variable: server + label: NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: path + label: Path on NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: setPermissionsSimple + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "simpleHP"]] + type: boolean + default: false + - variable: setPermissions + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "hostPath"]] + type: boolean + default: false + - variable: readOnly + label: Read Only + schema: + type: boolean + default: false + - variable: hostPathSimple + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "simpleHP"]] + type: hostpath + - variable: hostPath + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: EmptyDir Medium + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: Memory + description: Memory + - variable: size + label: Size quotum of Storage + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: 256Gi + - variable: hostPathType + label: (Advanced) hostPath Type + schema: + show_if: [["type", "=", "hostPath"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: DirectoryOrCreate + description: DirectoryOrCreate + - value: Directory + description: Directory + - value: FileOrCreate + description: FileOrCreate + - value: File + description: File + - value: Socket + description: Socket + - value: CharDevice + description: CharDevice + - value: BlockDevice + description: BlockDevice + - variable: storageClass + label: (Advanced) storageClass + description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: SCALE-ZFS + - variable: accessMode + label: (Advanced) Access Mode + description: Allow or disallow multiple PVC's writhing to the same PV + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: ReadWriteOnce + enum: + - value: ReadWriteOnce + description: ReadWriteOnce + - value: ReadOnlyMany + description: ReadOnlyMany + - value: ReadWriteMany + description: ReadWriteMany + - variable: advanced + label: Show Advanced Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: reports + label: App Reports Storage + description: Stores the Application Reports. + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Type of Storage + description: Sets the persistence type, Anything other than PVC could break rollback! + schema: + type: string + default: simplePVC + enum: + - value: simplePVC + description: PVC (simple) + - value: simpleHP + description: Host Path (simple) + - value: emptyDir + description: emptyDir + - value: pvc + description: PVC + - value: hostPath + description: Host Path + - value: nfs + description: NFS Share + - variable: server + label: NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: path + label: Path on NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: setPermissionsSimple + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "simpleHP"]] + type: boolean + default: false + - variable: setPermissions + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "hostPath"]] + type: boolean + default: false + - variable: readOnly + label: Read Only + schema: + type: boolean + default: false + - variable: hostPathSimple + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "simpleHP"]] + type: hostpath + - variable: hostPath + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: EmptyDir Medium + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: Memory + description: Memory + - variable: size + label: Size quotum of Storage + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: 256Gi + - variable: hostPathType + label: (Advanced) hostPath Type + schema: + show_if: [["type", "=", "hostPath"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: DirectoryOrCreate + description: DirectoryOrCreate + - value: Directory + description: Directory + - value: FileOrCreate + description: FileOrCreate + - value: File + description: File + - value: Socket + description: Socket + - value: CharDevice + description: CharDevice + - value: BlockDevice + description: BlockDevice + - variable: storageClass + label: (Advanced) storageClass + description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: SCALE-ZFS + - variable: accessMode + label: (Advanced) Access Mode + description: Allow or disallow multiple PVC's writhing to the same PV + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: ReadWriteOnce + enum: + - value: ReadWriteOnce + description: ReadWriteOnce + - value: ReadOnlyMany + description: ReadOnlyMany + - value: ReadWriteMany + description: ReadWriteMany + - variable: advanced + label: Show Advanced Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: scripts + label: App Scripts Storage + description: Stores the Application Scripts. + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Type of Storage + description: Sets the persistence type, Anything other than PVC could break rollback! + schema: + type: string + default: simplePVC + enum: + - value: simplePVC + description: PVC (simple) + - value: simpleHP + description: Host Path (simple) + - value: emptyDir + description: emptyDir + - value: pvc + description: PVC + - value: hostPath + description: Host Path + - value: nfs + description: NFS Share + - variable: server + label: NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: path + label: Path on NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: setPermissionsSimple + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "simpleHP"]] + type: boolean + default: false + - variable: setPermissions + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "hostPath"]] + type: boolean + default: false + - variable: readOnly + label: Read Only + schema: + type: boolean + default: false + - variable: hostPathSimple + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "simpleHP"]] + type: hostpath + - variable: hostPath + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: EmptyDir Medium + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: Memory + description: Memory + - variable: size + label: Size quotum of Storage + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: 256Gi + - variable: hostPathType + label: (Advanced) hostPath Type + schema: + show_if: [["type", "=", "hostPath"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: DirectoryOrCreate + description: DirectoryOrCreate + - value: Directory + description: Directory + - value: FileOrCreate + description: FileOrCreate + - value: File + description: File + - value: Socket + description: Socket + - value: CharDevice + description: CharDevice + - value: BlockDevice + description: BlockDevice + - variable: storageClass + label: (Advanced) storageClass + description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: SCALE-ZFS + - variable: accessMode + label: (Advanced) Access Mode + description: Allow or disallow multiple PVC's writhing to the same PV + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: ReadWriteOnce + enum: + - value: ReadWriteOnce + description: ReadWriteOnce + - value: ReadOnlyMany + description: ReadOnlyMany + - value: ReadWriteMany + description: ReadWriteMany + - variable: advanced + label: Show Advanced Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: media + label: App Media Storage + description: Stores the Application Media. + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Type of Storage + description: Sets the persistence type, Anything other than PVC could break rollback! + schema: + type: string + default: simplePVC + enum: + - value: simplePVC + description: PVC (simple) + - value: simpleHP + description: Host Path (simple) + - value: emptyDir + description: emptyDir + - value: pvc + description: PVC + - value: hostPath + description: Host Path + - value: nfs + description: NFS Share + - variable: server + label: NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: path + label: Path on NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: setPermissionsSimple + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "simpleHP"]] + type: boolean + default: false + - variable: setPermissions + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "hostPath"]] + type: boolean + default: false + - variable: readOnly + label: Read Only + schema: + type: boolean + default: false + - variable: hostPathSimple + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "simpleHP"]] + type: hostpath + - variable: hostPath + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: EmptyDir Medium + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: Memory + description: Memory + - variable: size + label: Size quotum of Storage + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: 256Gi + - variable: hostPathType + label: (Advanced) hostPath Type + schema: + show_if: [["type", "=", "hostPath"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: DirectoryOrCreate + description: DirectoryOrCreate + - value: Directory + description: Directory + - value: FileOrCreate + description: FileOrCreate + - value: File + description: File + - value: Socket + description: Socket + - value: CharDevice + description: CharDevice + - value: BlockDevice + description: BlockDevice + - variable: storageClass + label: (Advanced) storageClass + description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: SCALE-ZFS + - variable: accessMode + label: (Advanced) Access Mode + description: Allow or disallow multiple PVC's writhing to the same PV + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: ReadWriteOnce + enum: + - value: ReadWriteOnce + description: ReadWriteOnce + - value: ReadOnlyMany + description: ReadOnlyMany + - value: ReadWriteMany + description: ReadWriteMany + - variable: advanced + label: Show Advanced Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: persistenceList + label: Additional App Storage + group: Storage and Persistence + schema: + type: list + default: [] + items: + - variable: persistenceListEntry + label: Custom Storage + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable the storage + schema: + type: boolean + default: true + hidden: true + - variable: name + label: Name (Optional) + description: "Not required, please set to config when mounting /config or temp when mounting /tmp" + schema: + type: string + - variable: type + label: Type of Storage + description: Sets the persistence type, Anything other than PVC could break rollback! + schema: + type: string + default: simpleHP + enum: + - value: simplePVC + description: PVC (Simple) + - value: simpleHP + description: Host Path (Simple) + - value: emptyDir + description: emptyDir + - value: pvc + description: PVC + - value: hostPath + description: Host Path + - value: nfs + description: NFS Share + - variable: server + label: NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: path + label: Path on NFS Server + schema: + show_if: [["type", "=", "nfs"]] + type: string + default: "" + - variable: setPermissionsSimple + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "simpleHP"]] + type: boolean + default: false + - variable: setPermissions + label: Automatic Permissions + description: Automatically set permissions on install + schema: + show_if: [["type", "=", "hostPath"]] + type: boolean + default: false + - variable: readOnly + label: Read Only + schema: + type: boolean + default: false + - variable: hostPathSimple + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "simpleHP"]] + type: hostpath + - variable: hostPath + label: Host Path + description: Path inside the container the storage is mounted + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: mountPath + label: Mount Path + description: Path inside the container the storage is mounted + schema: + type: string + default: "" + required: true + valid_chars: '^\/([a-zA-Z0-9._-]+(\s?[a-zA-Z0-9._-]+|\/?))+$' + - variable: medium + label: EmptyDir Medium + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: Memory + description: Memory + - variable: size + label: Size Quotum of Storage + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: 256Gi + - variable: hostPathType + label: (Advanced) Host Path Type + schema: + show_if: [["type", "=", "hostPath"]] + type: string + default: "" + enum: + - value: "" + description: Default + - value: DirectoryOrCreate + description: DirectoryOrCreate + - value: Directory + description: Directory + - value: FileOrCreate + description: FileOrCreate + - value: File + description: File + - value: Socket + description: Socket + - value: CharDevice + description: CharDevice + - value: BlockDevice + description: BlockDevice + - variable: storageClass + label: (Advanced) StorageClass + description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: SCALE-ZFS + - variable: accessMode + label: (Advanced) Access Mode + description: Allow or disallow multiple PVC's writhing to the same PV + schema: + show_if: [["type", "=", "pvc"]] + type: string + default: ReadWriteOnce + enum: + - value: ReadWriteOnce + description: ReadWriteOnce + - value: ReadOnlyMany + description: ReadOnlyMany + - value: ReadWriteMany + description: ReadWriteMany + - variable: advanced + label: Show Advanced Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: ingress + label: "" + group: Ingress + schema: + additional_attrs: true + type: dict + attrs: + - variable: main + label: Main Ingress + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable Ingress + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: hosts + label: Hosts + schema: + type: list + default: [] + items: + - variable: hostEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: host + label: HostName + schema: + type: string + default: "" + required: true + - variable: paths + label: Paths + schema: + type: list + default: [] + items: + - variable: pathEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: path + label: Path + schema: + type: string + required: true + default: "/" + - variable: pathType + label: Path Type + schema: + type: string + required: true + default: Prefix + - variable: tls + label: TLS-Settings + schema: + type: list + default: [] + items: + - variable: tlsEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: hosts + label: Certificate Hosts + schema: + type: list + default: [] + items: + - variable: host + label: Host + schema: + type: string + default: "" + required: true + - variable: scaleCert + label: Select TrueNAS SCALE Certificate + schema: + type: int + $ref: + - "definitions/certificate" + - variable: entrypoint + label: (Advanced) Traefik Entrypoint + description: Entrypoint used by Traefik when using Traefik as Ingress Provider + schema: + type: string + default: websecure + required: true + - variable: middlewares + label: Traefik Middlewares + description: Add previously created Traefik Middlewares to this Ingress + schema: + type: list + default: [] + items: + - variable: name + label: Name + schema: + type: string + default: "" + required: true + - variable: expert + label: Show Expert Configuration Options + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: enableFixedMiddlewares + description: These middlewares enforce a number of best practices. + label: Enable Default Middlewares + schema: + type: boolean + default: true + - variable: ingressClassName + label: IngressClass Name + schema: + type: string + default: "" + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: ingressList + label: Add Manual Custom Ingresses + group: Ingress + schema: + type: list + default: [] + items: + - variable: ingressListEntry + label: Custom Ingress + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable Ingress + schema: + type: boolean + default: true + hidden: true + - variable: name + label: Name + schema: + type: string + default: "" + - variable: ingressClassName + label: IngressClass Name + schema: + type: string + default: "" + - variable: labelsList + label: Labels + schema: + type: list + default: [] + items: + - variable: labelItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: annotationsList + label: Annotations + schema: + type: list + default: [] + items: + - variable: annotationItem + label: Label + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + - variable: value + label: Value + schema: + type: string + - variable: hosts + label: Hosts + schema: + type: list + default: [] + items: + - variable: hostEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: host + label: HostName + schema: + type: string + default: "" + required: true + - variable: paths + label: Paths + schema: + type: list + default: [] + items: + - variable: pathEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: path + label: Path + schema: + type: string + required: true + default: "/" + - variable: pathType + label: Path Type + schema: + type: string + required: true + default: Prefix + - variable: service + label: Linked Service + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Service Name + schema: + type: string + default: "" + - variable: port + label: Service Port + schema: + type: int + - variable: tls + label: TLS-Settings + schema: + type: list + default: [] + items: + - variable: tlsEntry + label: Host + schema: + additional_attrs: true + type: dict + attrs: + - variable: hosts + label: Certificate Hosts + schema: + type: list + default: [] + items: + - variable: host + label: Host + schema: + type: string + default: "" + required: true + - variable: scaleCert + label: Select TrueNAS SCALE Certificate + schema: + type: int + $ref: + - "definitions/certificate" + - variable: entrypoint + label: Traefik Entrypoint + description: Entrypoint used by Traefik when using Traefik as Ingress Provider + schema: + type: string + default: websecure + required: true + - variable: middlewares + label: Traefik Middlewares + description: Add previously created Traefik Middlewares to this Ingress + schema: + type: list + default: [] + items: + - variable: name + label: Name + schema: + type: string + default: "" + required: true + - variable: security + label: Container Security Settings + group: Security and Permissions + schema: + type: dict + additional_attrs: true + attrs: + - variable: editsecurity + label: Change PUID / UMASK values + description: By enabling this you override default set values. + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: PUID + label: Process User ID - PUID + description: When supported by the container, this sets the User ID running the Application Process. Not supported by all Apps + schema: + type: int + default: 568 + - variable: UMASK + label: UMASK + description: When supported by the container, this sets the UMASK for the App. Not supported by all Apps + schema: + type: string + default: "002" + - variable: advancedSecurity + label: Show Advanced Security Settings + group: Security and Permissions + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: securityContext + label: Security Context + schema: + additional_attrs: true + type: dict + attrs: + - variable: privileged + label: Privileged mode + schema: + type: boolean + default: false + - variable: readOnlyRootFilesystem + label: ReadOnly Root Filesystem + schema: + type: boolean + default: false + - variable: allowPrivilegeEscalation + label: Allow Privilege Escalation + schema: + type: boolean + default: false + - variable: runAsNonRoot + label: runAsNonRoot + schema: + type: boolean + default: false + - variable: capabilities + label: Capabilities + schema: + additional_attrs: true + type: dict + attrs: + - variable: drop + label: Drop Capability + schema: + type: list + default: [] + items: + - variable: dropEntry + label: "" + schema: + type: string + - variable: add + label: Add Capability + schema: + type: list + default: [] + items: + - variable: addEntry + label: "" + schema: + type: string + - variable: podSecurityContext + group: Security and Permissions + label: Pod Security Context + schema: + additional_attrs: true + type: dict + attrs: + - variable: runAsUser + label: runAsUser + description: The UserID of the user running the application + schema: + type: int + default: 0 + - variable: runAsGroup + label: runAsGroup + description: The groupID this App of the user running the application + schema: + type: int + default: 0 + - variable: fsGroup + label: fsGroup + description: The group that should own ALL storage. + schema: + type: int + default: 568 + - variable: fsGroupChangePolicy + label: "When should we take ownership?" + schema: + type: string + default: OnRootMismatch + enum: + - value: OnRootMismatch + description: OnRootMismatch + - value: Always + description: Always + - variable: supplementalGroups + label: Supplemental Groups + schema: + type: list + default: [] + items: + - variable: supplementalGroupsEntry + label: Supplemental Group + schema: + type: int + + - variable: advancedresources + label: Set Custom Resource Limits/Requests (Advanced) + group: Resources and Devices + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: resources + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: limits + label: Advanced Limit Resource Consumption + schema: + additional_attrs: true + type: dict + attrs: + - variable: cpu + label: CPU + description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation" + schema: + type: string + default: 4000m + valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$' + - variable: memory + label: RAM + description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation" + schema: + type: string + default: 8Gi + valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$' + - variable: requests + label: "Minimum Resources Required (request)" + schema: + additional_attrs: true + type: dict + attrs: + - variable: cpu + label: CPU + description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation" + schema: + type: string + default: 10m + valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$' + - variable: memory + label: "RAM" + description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation" + schema: + type: string + default: 50Mi + valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$' + - variable: deviceList + label: Mount USB Devices + group: Resources and Devices + schema: + type: list + default: [] + items: + - variable: deviceListEntry + label: Device + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enable the Storage + schema: + type: boolean + default: true + - variable: type + label: (Advanced) Type of Storage + description: Sets the persistence type + schema: + type: string + default: hostPath + hidden: true + - variable: readOnly + label: readOnly + schema: + type: boolean + default: false + - variable: hostPath + label: Host Device Path + description: Path to the device on the host system + schema: + type: path + - variable: mountPath + label: Container Device Path + description: Path inside the container the device is mounted + schema: + type: string + default: "/dev/ttyACM0" + # Specify GPU configuration + - variable: scaleGPU + label: GPU Configuration + group: Resources and Devices + schema: + type: dict + $ref: + - "definitions/gpuConfiguration" + attrs: [] + - variable: metrics + group: Metrics + label: Prometheus Metrics + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enabled + description: Enable Prometheus Metrics + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: serviceMonitor + label: Service Monitor Settings + schema: + additional_attrs: true + type: dict + attrs: + - variable: interval + label: Scrape Interval + description: Scrape interval time + schema: + type: string + default: 1m + required: true + - variable: scrapeTimeout + label: Scrape Timeout + description: Scrape timeout Time + schema: + type: string + default: 30s + required: true + - variable: horizontalPodAutoscaler + group: Advanced + label: (Advanced) Horizontal Pod Autoscaler + schema: + type: list + default: [] + items: + - variable: hpaEntry + label: HPA Entry + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + default: "" + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: target + label: Target + description: Deployment name, Defaults to Main Deployment + schema: + type: string + default: "" + - variable: minReplicas + label: Minimum Replicas + schema: + type: int + default: 1 + - variable: maxReplicas + label: Maximum Replicas + schema: + type: int + default: 5 + - variable: targetCPUUtilizationPercentage + label: Target CPU Utilization Percentage + schema: + type: int + default: 80 + - variable: targetMemoryUtilizationPercentage + label: Target Memory Utilization Percentage + schema: + type: int + default: 80 + - variable: networkPolicy + group: Advanced + label: (Advanced) Network Policy + schema: + type: list + default: [] + items: + - variable: netPolicyEntry + label: Network Policy Entry + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + default: "" + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: policyType + label: Policy Type + schema: + type: string + default: "" + enum: + - value: "" + description: Default + - value: ingress + description: Ingress + - value: egress + description: Egress + - value: ingress-egress + description: Ingress and Egress + - variable: egress + label: Egress + schema: + type: list + default: [] + items: + - variable: egressEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: to + label: To + schema: + type: list + default: [] + items: + - variable: toEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: ipBlock + label: IP Block + schema: + additional_attrs: true + type: dict + attrs: + - variable: cidr + label: CIDR + schema: + type: string + default: "" + - variable: except + label: Except + schema: + type: list + default: [] + items: + - variable: exceptint + label: "" + schema: + type: string + - variable: namespaceSelector + label: Namespace Selector + schema: + additional_attrs: true + type: dict + attrs: + - variable: matchExpressions + label: Match Expressions + schema: + type: list + default: [] + items: + - variable: expressionEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: key + label: Key + schema: + type: string + - variable: operator + label: Operator + schema: + type: string + default: TCP + enum: + - value: In + description: In + - value: NotIn + description: NotIn + - value: Exists + description: Exists + - value: DoesNotExist + description: DoesNotExist + - variable: values + label: Values + schema: + type: list + default: [] + items: + - variable: value + label: "" + schema: + type: string + - variable: podSelector + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: matchExpressions + label: Match Expressions + schema: + type: list + default: [] + items: + - variable: expressionEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: key + label: Key + schema: + type: string + - variable: operator + label: Operator + schema: + type: string + default: TCP + enum: + - value: In + description: In + - value: NotIn + description: NotIn + - value: Exists + description: Exists + - value: DoesNotExist + description: DoesNotExist + - variable: values + label: Values + schema: + type: list + default: [] + items: + - variable: value + label: "" + schema: + type: string + - variable: ports + label: Ports + schema: + type: list + default: [] + items: + - variable: portsEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: Port + schema: + type: int + - variable: endPort + label: End Port + schema: + type: int + - variable: protocol + label: Protocol + schema: + type: string + default: TCP + enum: + - value: TCP + description: TCP + - value: UDP + description: UDP + - value: SCTP + description: SCTP + - variable: ingress + label: Ingress + schema: + type: list + default: [] + items: + - variable: ingressEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: from + label: From + schema: + type: list + default: [] + items: + - variable: fromEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: ipBlock + label: IP Block + schema: + additional_attrs: true + type: dict + attrs: + - variable: cidr + label: CIDR + schema: + type: string + default: "" + - variable: except + label: Except + schema: + type: list + default: [] + items: + - variable: exceptint + label: "" + schema: + type: string + - variable: namespaceSelector + label: Namespace Selector + schema: + additional_attrs: true + type: dict + attrs: + - variable: matchExpressions + label: Match Expressions + schema: + type: list + default: [] + items: + - variable: expressionEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: key + label: Key + schema: + type: string + - variable: operator + label: Operator + schema: + type: string + default: TCP + enum: + - value: In + description: In + - value: NotIn + description: NotIn + - value: Exists + description: Exists + - value: DoesNotExist + description: DoesNotExist + - variable: values + label: Values + schema: + type: list + default: [] + items: + - variable: value + label: "" + schema: + type: string + - variable: podSelector + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: matchExpressions + label: Match Expressions + schema: + type: list + default: [] + items: + - variable: expressionEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: key + label: Key + schema: + type: string + - variable: operator + label: Operator + schema: + type: string + default: TCP + enum: + - value: In + description: In + - value: NotIn + description: NotIn + - value: Exists + description: Exists + - value: DoesNotExist + description: DoesNotExist + - variable: values + label: Values + schema: + type: list + default: [] + items: + - variable: value + label: "" + schema: + type: string + - variable: ports + label: Ports + schema: + type: list + default: [] + items: + - variable: portsEntry + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: Port + schema: + type: int + - variable: endPort + label: End Port + schema: + type: int + - variable: protocol + label: Protocol + schema: + type: string + default: TCP + enum: + - value: TCP + description: TCP + - value: UDP + description: UDP + - value: SCTP + description: SCTP + - variable: addons + group: Addons + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: codeserver + label: Codeserver + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: git + label: Git Settings + schema: + additional_attrs: true + type: dict + attrs: + - variable: deployKey + description: Raw SSH Private Key + label: Deploy Key + schema: + type: string + - variable: deployKeyBase64 + description: Base64-encoded SSH private key. When both variables are set, the raw SSH key takes precedence + label: Deploy Key Base64 + schema: + type: string + - variable: service + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Service Type + description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer" + schema: + type: string + default: LoadBalancer + enum: + - value: NodePort + description: Deprecated CHANGE THIS + - value: ClusterIP + description: ClusterIP + - value: LoadBalancer + description: LoadBalancer + - variable: loadBalancerIP + label: LoadBalancer IP + description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB" + schema: + show_if: [["type", "=", "LoadBalancer"]] + type: string + default: "" + - variable: advancedsvcset + label: Show Advanced Service Settings + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: externalIPs + label: "External IP's" + description: "External IP's" + schema: + type: list + default: [] + items: + - variable: externalIP + label: External IP + schema: + type: string + - variable: ipFamilyPolicy + label: IP Family Policy + description: Specify the IP Policy + schema: + type: string + default: SingleStack + enum: + - value: SingleStack + description: SingleStack + - value: PreferDualStack + description: PreferDualStack + - value: RequireDualStack + description: RequireDualStack + - variable: ipFamilies + label: IP Families + description: (Advanced) The IP Families that should be used + schema: + type: list + default: [] + items: + - variable: ipFamily + label: IP Family + schema: + type: string + - variable: ports + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: codeserver + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: Port + schema: + type: int + default: 36107 + - variable: nodePort + description: Leave Empty to Disable + label: nodePort DEPRECATED + schema: + type: int + default: 36107 + - variable: envList + label: Codeserver Environment Variables + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: envItem + label: Environment Variable + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: value + label: Value + schema: + type: string + required: true + - variable: promtail + label: Promtail + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: loki + label: Loki URL + schema: + type: string + required: true + - variable: logs + label: Log Paths + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: path + label: Path + schema: + type: string + required: true + - variable: args + label: Promtail Command Line Arguments + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: arg + label: Arg + schema: + type: string + required: true + - variable: envList + label: Promtail Environment Variables + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: envItem + label: Environment Variable + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: value + label: Value + schema: + type: string + required: true + - variable: netshoot + label: Netshoot + schema: + additional_attrs: true + type: dict + attrs: + - variable: enabled + label: Enabled + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: envList + label: Netshoot Environment Variables + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: envItem + label: Environment Variable + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: value + label: Value + schema: + type: string + required: true + - variable: vpn + label: VPN + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: Type + schema: + type: string + default: disabled + enum: + - value: disabled + description: disabled + - value: openvpn + description: OpenVPN + - value: wireguard + description: Wireguard + - value: tailscale + description: Tailscale + - variable: openvpn + label: OpenVPN Settings + schema: + type: dict + show_if: [["type", "=", "openvpn"]] + attrs: + - variable: username + label: Authentication Username (Optional) + description: Authentication Username, Optional + schema: + type: string + default: "" + - variable: password + label: Authentication Password + description: Authentication Credentials + schema: + type: string + default: "" + required: true + - variable: tailscale + label: Tailscale Settings + schema: + type: dict + show_if: [["type", "=", "tailscale"]] + attrs: + - variable: authkey + label: Authentication Key + description: Provide an auth key to automatically authenticate the node as your user account. + schema: + type: string + private: true + default: "" + - variable: auth_once + label: Auth Once + description: Only attempt to log in if not already logged in. + schema: + type: boolean + default: true + - variable: accept_dns + label: Accept DNS + description: Accept DNS configuration from the admin console. + schema: + type: boolean + default: false + - variable: userspace + label: Userspace + description: Userspace Networking mode allows running Tailscale where you do not have access to create a VPN tunnel device. + schema: + type: boolean + default: false + - variable: routes + label: Routes + description: Expose physical subnet routes to your entire Tailscale network. + schema: + type: string + default: "" + - variable: dest_ip + label: Destination IP + description: Tells the DNAT mechanism which Destination IP to set in the IP header, and where to send packets that are matched. + schema: + type: string + default: "" + - variable: sock5_server + label: Sock5 Server + description: The address on which to listen for SOCKS5 proxying into the tailscale net. + schema: + type: string + default: "" + - variable: outbound_http_proxy_listen + label: Outbound HTTP Proxy Listen + description: The address on which to listen for HTTP proxying into the tailscale net. + schema: + type: string + default: "" + - variable: extra_args + label: Extra Args + description: Extra Args + schema: + type: string + default: "" + - variable: daemon_extra_args + label: Tailscale Daemon Extra Args + description: Tailscale Daemon Extra Args + schema: + type: string + default: "" + - variable: killSwitch + label: Enable Killswitch + schema: + type: boolean + show_if: [["type", "!=", "disabled"]] + default: true + - variable: excludedNetworks_IPv4 + label: Killswitch Excluded IPv4 networks + description: List of Killswitch Excluded IPv4 Addresses + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: networkv4 + label: IPv4 Network + schema: + type: string + required: true + - variable: excludedNetworks_IPv6 + label: Killswitch Excluded IPv6 networks + description: "List of Killswitch Excluded IPv6 Addresses" + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: networkv6 + label: IPv6 Network + schema: + type: string + required: true + - variable: configFile + label: VPN Config File Location + schema: + type: dict + show_if: [["type", "!=", "disabled"]] + attrs: + - variable: enabled + label: Enabled + schema: + type: boolean + default: true + hidden: true + - variable: type + label: Type + schema: + type: string + default: hostPath + hidden: true + - variable: hostPathType + label: hostPathType + schema: + type: string + default: File + hidden: true + - variable: noMount + label: noMount + schema: + type: boolean + default: true + hidden: true + - variable: hostPath + label: Full Path to File + description: "Path to your local VPN config file for example: /mnt/tank/vpn.conf or /mnt/tank/vpn.ovpn" + schema: + type: string + default: "" + - variable: envList + label: VPN Environment Variables + schema: + type: list + show_if: [["type", "!=", "disabled"]] + default: [] + items: + - variable: envItem + label: Environment Variable + schema: + additional_attrs: true + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: value + label: Value + schema: + type: string + required: true + - variable: docs + group: Documentation + label: Please read the documentation at https://truecharts.org + description: Please read the documentation at +
https://truecharts.org + schema: + additional_attrs: true + type: dict + attrs: + - variable: confirmDocs + label: I have checked the documentation + schema: + type: boolean + default: true + - variable: donateNag + group: Documentation + label: Please consider supporting TrueCharts, see https://truecharts.org/sponsor + description: Please consider supporting TrueCharts, see +
https://truecharts.org/sponsor + schema: + additional_attrs: true + type: dict + attrs: + - variable: confirmDonate + label: I have considered donating + schema: + type: boolean + default: true + hidden: true diff --git a/incubator/netbox/0.0.1/templates/_housekeeper.tpl b/incubator/netbox/0.0.1/templates/_housekeeper.tpl new file mode 100644 index 00000000000..43edc3ea6ab --- /dev/null +++ b/incubator/netbox/0.0.1/templates/_housekeeper.tpl @@ -0,0 +1,33 @@ +{{/* Define the housekeeper container */}} +{{- define "netbox.housekeeper" -}} +image: {{ .Values.image.repository }}:{{ .Values.image.tag }} +imagePullPolicy: {{ .Values.image.pullPolicy }} +securityContext: + runAsUser: {{ .Values.podSecurityContext.runAsUser }} + runAsGroup: {{ .Values.podSecurityContext.runAsGroup }} + readOnlyRootFilesystem: {{ .Values.securityContext.readOnlyRootFilesystem }} + runAsNonRoot: {{ .Values.securityContext.runAsNonRoot }} +command: + - /bin/bash + - -c + - | + echo "Starting housekeeper..." + until $(curl --output /dev/null --silent --head --fail http://127.0.0.1:8080/login); do + echo "Housekeeper: Waiting for the main netbox container..." + sleep 5 + done + /opt/netbox/housekeeping.sh + echo "Housekeeper finished, exiting..." +volumeMounts: + - name: config + mountPath: /etc/netbox/config + - name: reports + mountPath: /etc/netbox/reports + - name: scripts + mountPath: /etc/netbox/scritps + - name: media + mountPath: /opt/netbox/netbox/media + - name: configfile + mountPath: /etc/netbox/config/01-config.py + subPath: config.py +{{- end -}} diff --git a/incubator/netbox/0.0.1/templates/_secret.tpl b/incubator/netbox/0.0.1/templates/_secret.tpl new file mode 100644 index 00000000000..6d53f94fded --- /dev/null +++ b/incubator/netbox/0.0.1/templates/_secret.tpl @@ -0,0 +1,376 @@ +{{/* Define the secret */}} +{{- define "netbox.secret" -}} + +{{- $secretName := printf "%s-secret" (include "tc.common.names.fullname" .) }} + +{{- $secret_key := "" }} +{{- with (lookup "v1" "Secret" .Release.Namespace $secretName) }} + {{- $secret_key = (index .data "secret_key") }} +{{- else }} + {{- $secret_key = randAlphaNum 64 }} +{{- end }} + +--- + +apiVersion: v1 +kind: Secret +type: Opaque +metadata: + name: {{ $secretName }} + labels: + {{- include "tc.common.labels" . | nindent 4 }} +data: + secret_key: {{ $secret_key | b64enc }} +stringData: + config.py: | + ALLOWED_HOSTS = [ + '127.0.0.1', + '::1', + {{- range .Values.netbox.allowed_hosts }} + {{ . | squote }}, + {{- end }} + ] + + DATABASE = { + 'NAME': '{{ .Values.postgresql.postgresqlDatabase }}', + 'USER': '{{ .Values.postgresql.postgresqlUsername }}', + 'PASSWORD': '{{ .Values.postgresql.postgresqlPassword | trimAll "\"" }}', + 'HOST': '{{ printf "%v-%v" .Release.Name "postgresql" }}', + 'PORT': '5432', + 'CONN_MAX_AGE': 300, + } + + REDIS = { + 'tasks': { + 'HOST': '{{ printf "%v-%v" .Release.Name "redis" }}', + 'PORT': 6379, + 'PASSWORD': '{{ .Values.redis.redisPassword | trimAll "\"" }}', + 'DATABASE': 0, + 'SSL': False, + }, + 'caching': { + 'HOST': '{{ printf "%v-%v" .Release.Name "redis" }}', + 'PORT': 6379, + 'PASSWORD': '{{ .Values.redis.redisPassword | trimAll "\"" }}', + 'DATABASE': 1, + 'SSL': False, + } + } + + SECRET_KEY = '{{ $secret_key }}' + + {{- with .Values.netbox.admins }} + ADMINS = [ + {{- range . }} + ({{ .name | squote }},{{ .email | squote }}), + {{- end }} + ] + {{- end }} + + {{- with .Values.netbox.allowed_urls_schemes}} + ALLOWED_URL_SCHEMES = [ + {{- range . }} + {{ . | squote }}, + {{- end }} + ] + {{- end }} + + {{- with .Values.netbox.auth_password_validators }} + AUTH_PASSWORD_VALIDATORS = [ + {{- range . }} + { + 'NAME': {{ .name | squote }}, + 'OPTIONS': { + {{- range .options }} + {{ .key | squote }}: {{ .value }}, + {{- end }} + } + + }, + {{- end }} + ] + {{- end }} + + {{- with .Values.netbox.banner.top }} + BANNER_TOP = {{ . | squote }} + {{- end }} + + {{- with .Values.netbox.banner.bottom }} + BANNER_BOTTOM = {{ . | squote }} + {{- end }} + + {{- with .Values.netbox.banner.login }} + BANNER_LOGIN = {{ . | squote }} + {{- end }} + + {{- if or .Values.netbox.retention.changelog (eq (int .Values.netbox.retention.changelog) 0) }} + CHANGELOG_RETENTION = {{ .Values.netbox.retention.changelog }} + {{- end }} + + {{- if or .Values.netbox.retention.job_result (eq (int .Values.netbox.retention.job_result) 0) }} + JOBRESULT_RETENTION = {{ .Values.netbox.retention.job_result }} + {{- end }} + + PREFER_IPV4 = {{ ternary "True" "False" .Values.netbox.prefer_ipv4 }} + + ENFORCE_GLOBAL_UNIQUE = {{ ternary "True" "False" .Values.netbox.enforce_global_unique }} + + GRAPHQL_ENABLED = {{ ternary "True" "False" .Values.netbox.graphql_enabled }} + + {{- with .Values.netbox.maps_url }} + MAPS_URL = {{ . | squote }} + {{- end }} + + {{- if or .Values.netbox.max_page_size (eq (int .Values.netbox.max_page_size) 0) }} + MAX_PAGE_SIZE = {{ .Values.netbox.max_page_size }} + {{- end }} + + {{- if or .Values.netbox.paginate_count (eq (int .Values.netbox.paginate_count) 0) }} + PAGINATE_COUNT = {{ .Values.netbox.paginate_count }} + {{- end }} + + {{- with .Values.netbox.powerfeed.default_amperage }} + POWERFEED_DEFAULT_AMPERAGE = {{ . }} + {{- end }} + + {{- with .Values.netbox.powerfeed.default_max_utilization }} + POWERFEED_DEFAULT_MAX_UTILIZATION = {{ . }} + {{- end }} + + {{- with .Values.netbox.powerfeed.default_voltage }} + POWERFEED_DEFAULT_VOLTAGE = {{ . }} + {{- end }} + + {{- with .Values.netbox.rack.elevation_default_unit_height }} + RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = {{ . }} + {{- end }} + + {{- with .Values.netbox.rack.elevation_default_unit_width }} + RACK_ELEVATION_DEFAULT_UNIT_WIDTH = {{ . }} + {{- end }} + + {{- with .Values.netbox.napalm.username }} + NAPALM_USERNAME = {{ . | squote }} + {{- end }} + + {{- with .Values.netbox.napalm.password }} + NAPALM_PASSWORD = {{ . | squote }} + {{- end }} + + {{- with .Values.netbox.napalm.timeout }} + NAPALM_TIMEOUT = {{ . }} + {{- end }} + + {{- with .Values.netbox.napalm.args }} + NAPALM_ARGS = { + {{- range . }} + {{ .arg | squote }}: {{ .value | squote }}, + {{- end }} + } + {{- end }} + + {{- with .Values.netbox.csrf_trusted_origin }} + CSRF_TRUSTED_ORIGINS = [ + {{ . | squote }}, + ] + {{- end }} + + {{- with .Values.netbox.csrf_cookie_name }} + CSRF_COOKIE_NAME = {{ . | squote }} + {{- end }} + + CORS_ORIGIN_ALLOW_ALL = {{ ternary "True" "False" .Values.netbox.cors_origin_allow_all }} + + {{- with .Values.netbox.cors_origin_whitelist }} + CORS_ORIGIN_WHITELIST = [ + {{- range . }} + {{ . | squote }}, + {{- end }} + ] + {{- end }} + + {{- with .Values.netbox.cors_origin_regex_whitelist }} + CORS_ORIGIN_REGEX_WHITELIST = [ + {{- range . }} + {{ . }}, + {{- end }} + ] + {{- end }} + + DEBUG = {{ ternary "True" "False" .Values.netbox.debug }} + + {{- if .Values.netbox.email }} + {{- if .Values.netbox.email.server }} + EMAIL = { + {{- with .Values.netbox.email.server }} + 'SERVER': {{ . | squote }}, + {{- end }} + {{- with .Values.netbox.email.port }} + 'PORT': {{ . }}, + {{- end }} + {{- with .Values.netbox.email.username }} + 'USERNAME': {{ . | squote }}, + {{- end }} + {{- with .Values.netbox.email.password }} + 'PASSWORD': {{ . | squote }}, + {{- end }} + 'USE_SSL': {{ ternary "True" "False" .Values.netbox.email.use_ssl }}, + 'USE_TLS': {{ ternary "True" "False" .Values.netbox.email.use_tls }}, + {{- with .Values.netbox.email.timeout }} + 'TIMEOUT': {{ . }}, + {{- end }} + {{- with .Values.netbox.email.from_email }} + 'FROM_EMAIL': {{ . | squote }}, + {{- end }} + } + {{- end }} + {{- end }} + + {{- with .Values.netbox.exempt_view_permissions }} + EXEMPT_VIEW_PERMISSIONS = [ + {{- range . }} + {{ . | squote }}, + {{- end }} + ] + {{- end }} + + {{- with .Values.netbox.http_proxies }} + HTTP_PROXIES = { + {{- range . }} + {{ .key | squote }}: {{ .url | squote }}, + {{- end }} + } + {{- end }} + + {{- with .Values.netbox.internal_ips }} + INTERNAL_IPS = ( + '127.0.0.1', + '::1', + {{- range . }} + {{ . | squote }}, + {{- end }} + ) + {{- end }} + + LOGIN_PERSISTENCE = {{ ternary "True" "False" .Values.netbox.login_persistence }} + + LOGIN_REQUIRED = {{ ternary "True" "False" .Values.netbox.login_required }} + + {{- with .Values.netbox.login_timeout }} + LOGIN_TIMEOUT = {{ . }} + {{- end }} + + METRICS_ENABLED = {{ ternary "True" "False" .Values.metrics.enabled }} + + TIME_ZONE = {{ .Values.TZ | squote }} + + MEDIA_ROOT = '/opt/netbox/netbox/media' + REPORTS_ROOT = '/opt/netbox/netbox/reports' + SCRIPTS_ROOT = '/opt/netbox/netbox/scripts' + + {{- with .Values.netbox.storage_backend }} + STORAGE_BACKEND = {{ . | squote }} + {{- end }} + + {{- with .Values.netbox.storage_config }} + STORAGE_CONFIG = { + {{- range . }} + {{ .key | squote }}: {{ .value | squote }}, + {{- end }} + } + {{- end }} + + {{- $enabled_plugins := list -}} + {{- with .Values.netbox.plugin_config -}} + {{- range . -}} + {{- if .enabled -}} + {{- $enabled_plugins = append $enabled_plugins .plugin_name -}} + {{- end -}} + {{- end -}} + {{- end -}} + + {{- with $enabled_plugins }} + PLUGINS = [ + {{- range . }} + {{ . | squote }}, + {{- end }} + ] + {{- end }} + + {{/* + TODO: Consider template plugins here, so it's easier to config on UI + https://github.com/netbox-community/netbox/wiki/Plugins + */}} + {{- with .Values.netbox.plugin_config }} + PLUGINS_CONFIG = { + {{- range . }} + {{- if .enabled }} + {{ .plugin_name | squote }}: { + {{- range .config }} + {{ .key | squote }}: {{ .value | squote }}, + {{- end }} + } + {{- end }} + {{- end }} + } + {{- end }} + + {{- with .Values.netbox.rq_default_timeout }} + RQ_DEFAULT_TIMEOUT = {{ . }} + {{- end }} + + {{- with .Values.netbox.session_cookie_name }} + SESSION_COOKIE_NAME = {{ . | squote }} + {{- end }} + + RELEASE_CHECK_URL = 'https://api.github.com/repos/netbox-community/netbox/releases' + + {{- with .Values.netbox.remote_auth }} + {{- if .enabled }} + REMOTE_AUTH_ENABLED = True + {{- with .backend }} + REMOTE_AUTH_BACKEND = {{ . | squote }} + {{- end }} + {{- with .header }} + REMOTE_AUTH_HEADER = {{ . | squote }} + {{- end }} + REMOTE_AUTH_AUTO_CREATE_USER = {{ ternary "True" "False" .auto_create_user }} + {{- with .default_groups }} + REMOTE_AUTH_DEFAULT_GROUPS = [ + {{- range . }} + {{ . | squote }}, + {{- end }} + ] + {{- end }} + {{- with .default_permissions }} + REMOTE_AUTH_DEFAULT_PERMISSIONS = { + {{- range . }} + {{ .key | squote }}: {{ if eq .value "None" }}{{ .value }}{{ else }}{{ .value | squote }}{{ end }}, + {{- end }} + } + {{- end }} + {{- end }} + {{- end }} + SESSION_FILE_PATH = None + + {{- with .Values.netbox.date_time }} + {{- with .date_format }} + DATE_FORMAT = {{ . | squote }} + {{- end }} + {{- with .short_date_format }} + SHORT_DATE_FORMAT = {{ . | squote }} + {{- end }} + {{- with .time_format }} + TIME_FORMAT = {{ . | squote }} + {{- end }} + {{- with .shot_time_format }} + SHORT_TIME_FORMAT = {{ . | squote }} + {{- end }} + {{- with .date_time_format }} + DATETIME_FORMAT = {{ . | squote }} + {{- end }} + {{- with .short_date_time_format }} + SHORT_DATETIME_FORMAT = {{ . | squote }} + {{- end }} + {{- end }} +{{- end }} diff --git a/incubator/netbox/0.0.1/templates/_worker.tpl b/incubator/netbox/0.0.1/templates/_worker.tpl new file mode 100644 index 00000000000..41ff2f01b72 --- /dev/null +++ b/incubator/netbox/0.0.1/templates/_worker.tpl @@ -0,0 +1,56 @@ +{{/* Define the worker container */}} +{{- define "netbox.worker" -}} +image: {{ .Values.image.repository }}:{{ .Values.image.tag }} +imagePullPolicy: {{ .Values.image.pullPolicy }} +securityContext: + runAsUser: {{ .Values.podSecurityContext.runAsUser }} + runAsGroup: {{ .Values.podSecurityContext.runAsGroup }} + readOnlyRootFilesystem: {{ .Values.securityContext.readOnlyRootFilesystem }} + runAsNonRoot: {{ .Values.securityContext.runAsNonRoot }} +command: + - /bin/bash + - -c + - | + echo "Starting worker...." + until $(curl --output /dev/null --silent --head --fail http://127.0.0.1:8080/login); do + echo "Worker: Waiting for the main netbox container..." + sleep 5 + done + /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py rqworker +volumeMounts: + - name: config + mountPath: /etc/netbox/config + - name: reports + mountPath: /etc/netbox/reports + - name: scripts + mountPath: /etc/netbox/scritps + - name: media + mountPath: /opt/netbox/netbox/media + - name: configfile + mountPath: /etc/netbox/config/01-config.py + subPath: config.py +{{/*readinessProbe: + exec: + command: + - TODO: find a healthcheck + initialDelaySeconds: {{ .Values.probes.readiness.spec.initialDelaySeconds }} + timeoutSeconds: {{ .Values.probes.readiness.spec.timeoutSeconds }} + periodSeconds: {{ .Values.probes.readiness.spec.periodSeconds }} + failureThreshold: {{ .Values.probes.readiness.spec.failureThreshold }} +livenessProbe: + exec: + command: + - TODO: find a healthcheck + initialDelaySeconds: {{ .Values.probes.liveness.spec.initialDelaySeconds }} + timeoutSeconds: {{ .Values.probes.liveness.spec.timeoutSeconds }} + periodSeconds: {{ .Values.probes.liveness.spec.periodSeconds }} + failureThreshold: {{ .Values.probes.liveness.spec.failureThreshold }} +startupProbe: + exec: + command: + - TODO: find a healthcheck + initialDelaySeconds: {{ .Values.probes.startup.spec.initialDelaySeconds }} + timeoutSeconds: {{ .Values.probes.startup.spec.timeoutSeconds }} + periodSeconds: {{ .Values.probes.startup.spec.periodSeconds }} + failureThreshold: {{ .Values.probes.startup.spec.failureThreshold }}*/}} +{{- end -}} diff --git a/incubator/netbox/0.0.1/templates/common.yaml b/incubator/netbox/0.0.1/templates/common.yaml new file mode 100644 index 00000000000..36d5d8539ea --- /dev/null +++ b/incubator/netbox/0.0.1/templates/common.yaml @@ -0,0 +1,16 @@ +{{/* Make sure all variables are set properly */}} +{{- include "tc.common.loader.init" . }} + +{{- include "netbox.secret" . }} + +{{- $_ := set .Values.additionalContainers "worker" (include "netbox.worker" . | fromYaml) -}} +{{- $_ := set .Values.additionalContainers "housekeeper" (include "netbox.housekeeper" . | fromYaml) -}} + +{{- if .Values.metrics.enabled -}} +{{- $_ := set .Values.podAnnotations "prometheus.io/scrape" "true" -}} +{{- $_ := set .Values.podAnnotations "prometheus.io/path" "/metrics" -}} +{{- $_ := set .Values.podAnnotations "prometheus.io/port" (.Values.service.main.ports.main.targetPort | toString) -}} +{{- end -}} + +{{/* Render the templates */}} +{{ include "tc.common.loader.apply" . }} diff --git a/incubator/netbox/0.0.1/templates/prometheusrules.yaml b/incubator/netbox/0.0.1/templates/prometheusrules.yaml new file mode 100644 index 00000000000..35b77edf0f6 --- /dev/null +++ b/incubator/netbox/0.0.1/templates/prometheusrules.yaml @@ -0,0 +1,18 @@ +{{- if and .Values.metrics.enabled .Values.metrics.prometheusRule.enabled }} +apiVersion: monitoring.coreos.com/v1 +kind: PrometheusRule +metadata: + name: {{ include "tc.common.names.fullname" . }} + labels: + {{- include "tc.common.labels" . | nindent 4 }} + {{- with .Values.metrics.prometheusRule.labels }} + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + groups: + - name: {{ include "tc.common.names.fullname" . }} + rules: + {{- with .Values.metrics.prometheusRule.rules }} + {{- toYaml . | nindent 8 }} + {{- end }} +{{- end }} diff --git a/incubator/netbox/0.0.1/templates/servicemonitor.yaml b/incubator/netbox/0.0.1/templates/servicemonitor.yaml new file mode 100644 index 00000000000..3a719d761e1 --- /dev/null +++ b/incubator/netbox/0.0.1/templates/servicemonitor.yaml @@ -0,0 +1,24 @@ +{{- if .Values.metrics.enabled }} +apiVersion: monitoring.coreos.com/v1 +kind: ServiceMonitor +metadata: + name: {{ include "tc.common.names.fullname" . }} + labels: + {{- include "tc.common.labels" . | nindent 4 }} + {{- with .Values.metrics.serviceMonitor.labels }} + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + selector: + matchLabels: + {{- include "tc.common.labels.selectorLabels" . | nindent 6 }} + endpoints: + - port: http + {{- with .Values.metrics.serviceMonitor.interval }} + interval: {{ . }} + {{- end }} + {{- with .Values.metrics.serviceMonitor.scrapeTimeout }} + scrapeTimeout: {{ . }} + {{- end }} + path: /metrics +{{- end }} diff --git a/incubator/netbox/0.0.1/values.yaml b/incubator/netbox/0.0.1/values.yaml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/incubator/netbox/item.yaml b/incubator/netbox/item.yaml new file mode 100644 index 00000000000..24b089f5cf4 --- /dev/null +++ b/incubator/netbox/item.yaml @@ -0,0 +1,4 @@ +icon_url: https://truecharts.org/img/hotlink-ok/chart-icons/netbox.png +categories: +- network +