Init NetBox Operator Helm chart

.github/workflows/ci.yml

@@ -43,6 +43,7 @@ jobs:
     uses: ./.github/workflows/test.yml
     with:
       action-matrix: '["lint-and-install", "install --upgrade"]'
+    secrets: inherit
 
   release:
     name: Release

.github/workflows/lint.yml

@@ -32,7 +32,7 @@ jobs:
           VALIDATE_JSCPD: false
           VALIDATE_PYTHON_MYPY: false
           VALIDATE_PYTHON_PYINK: false
-          FILTER_REGEX_EXCLUDE: charts/\w+/templates/.*\.yaml
+          FILTER_REGEX_EXCLUDE: charts/[^/]+/[^/]+/.*\.yaml
           LINTER_RULES_PATH: /
           PYTHON_BLACK_CONFIG_FILE: pyproject.toml
           PYTHON_PYLINT_CONFIG_FILE: pyproject.toml

.github/workflows/test.yml

@@ -42,4 +42,6 @@ jobs:
         if: contains(matrix.action, 'install')
 
       - name: Run chart-testing (${{ matrix.action }})
-        run: ct ${{ matrix.action }} --config config.yaml --debug
+        run: ct ${{ matrix.action }} --config config.yaml --debug --helm-extra-set-args="$CT_HELM_EXTRA_SET_ARGS"
+        env:
+          CT_HELM_EXTRA_SET_ARGS: --set=host=${{ secrets.NETBOX_URL }} --set=auth.apiToken=${{ secrets.NETBOX_TOKEN }}

README.md

@@ -13,9 +13,10 @@ Do you have any questions?
 Before opening an issue on GitHub, please join [our Slack](https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ)
 and ask for help in the [`#netbox-chart`](https://netdev-community.slack.com/archives/C01Q6B100R2) channel.
 
-|               Chart               |                                                                                                           Version                                                                                                            |
-| :-------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| [`netbox/netbox`](charts/netbox/) | [![Chart Version](https://img.shields.io/badge/dynamic/json?label=netbox&query=version&url=https%3A%2F%2Fartifacthub.io%2Fapi%2Fv1%2Fpackages%2Fhelm%2Fnetbox%2Fnetbox)](https://artifacthub.io/packages/helm/netbox/netbox) |
+|                        Chart                        |                                                                                                                    Version                                                                                                                     |
+| :-------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+|          [`netbox/netbox`](charts/netbox/)          |          [![Chart Version](https://img.shields.io/badge/dynamic/json?label=netbox&query=version&url=https%3A%2F%2Fartifacthub.io%2Fapi%2Fv1%2Fpackages%2Fhelm%2Fnetbox%2Fnetbox)](https://artifacthub.io/packages/helm/netbox/netbox)          |
+| [`netbox/netbox-operator`](charts/netbox-operator/) | [![Chart Version](https://img.shields.io/badge/dynamic/json?label=netbox&query=version&url=https%3A%2F%2Fartifacthub.io%2Fapi%2Fv1%2Fpackages%2Fhelm%2Fnetbox%2Fnetbox-operator)](https://artifacthub.io/packages/helm/netbox/netbox-operator) |
 
 ## Quickstart
 

charts/netbox-operator/.helmignore

@@ -0,0 +1,29 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+
+# OWNERS file for Kubernetes
+OWNERS
+# example production yaml
+values-production.yaml
+# ci files
+ci/

charts/netbox-operator/Chart.yaml

@@ -0,0 +1,31 @@
+apiVersion: v2
+name: netbox-operator
+version: 0.1.0
+# renovate: image=ghcr.io/netbox-community/netbox-operator
+appVersion: "v0.1.0-alpha.1"
+type: application
+kubeVersion: ^1.25.0-0
+description: Operator to manage NetBox resources directly through Kubernetes
+home: https://netbox.dev/
+icon: https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg
+sources:
+  - https://github.com/netbox-community/netbox-operator
+  - https://github.com/netbox-community/netbox-chart
+maintainers:
+  - name: netbox-community
+    url: https://github.com/netbox-community
+dependencies:
+  - name: common
+    repository: oci://registry-1.docker.io/bitnamicharts
+    version: ^2.26.0
+    tags:
+      - bitnami-common
+  - name: netbox
+    version: ^5.0.0-beta.133
+    repository: oci://ghcr.io/netbox-community/netbox-chart
+    condition: netbox.enabled
+annotations:
+  artifacthub.io/license: Apache-2.0
+  artifacthub.io/links: |
+    - name: Upstream Project
+      url: https://github.com/netbox-community/netbox-operator

charts/netbox-operator/README.md

@@ -0,0 +1,35 @@
+# NetBox Operator
+
+[Operator](https://github.com/netbox-community/netbox-operator) to manage [NetBox](https://netbox.dev) resources directly through Kubernetes.
+
+## TL;DR
+
+```shell
+helm install netbox-operator oci://ghcr.io/netbox-community/netbox-chart/netbox-operator
+```
+
+## Prerequisites
+
+- Kubernetes [1.25+](https://kubernetes.io/releases/)
+- Helm [3.10+](https://helm.sh/docs/topics/version_skew/)
+- NetBox [4.0+](https://netboxlabs.com/docs/netbox/en/stable/release-notes/)
+
+> [!warning]
+> NetBox Operator requires additional NetBox configuration.
+> A custom field (by default `netboxOperatorRestorationHash`) must be added before operator installation.
+
+## Installing the Chart
+
+To install the chart with the release name `my-release` and default configuration:
+
+```shell
+helm install my-release oci://ghcr.io/netbox-community/netbox-chart/netbox-operator
+```
+
+## Configuration
+
+The configurable parameters for this chart and their default values are listed on the [`values.yaml`](./values.yaml) file.
+
+## License
+
+This project is licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

charts/netbox-operator/ci/default-values.yaml

@@ -0,0 +1 @@
+https: true

charts/netbox-operator/crds/ipaddressclaims.yaml

@@ -0,0 +1,164 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.14.0
+  name: ipaddressclaims.netbox.dev
+spec:
+  group: netbox.dev
+  names:
+    kind: IpAddressClaim
+    listKind: IpAddressClaimList
+    plural: ipaddressclaims
+    shortNames:
+      - ipc
+    singular: ipaddressclaim
+  scope: Namespaced
+  versions:
+    - additionalPrinterColumns:
+        - jsonPath: .status.ipAddress
+          name: IpAddress
+          type: string
+        - jsonPath: .status.conditions[?(@.type=="IPAssigned")].status
+          name: IpAssigned
+          type: string
+        - jsonPath: .status.conditions[?(@.type=="Ready")].status
+          name: Ready
+          type: string
+        - jsonPath: .metadata.creationTimestamp
+          name: Age
+          type: date
+      name: v1
+      schema:
+        openAPIV3Schema:
+          description: IpAddressClaim is the Schema for the ipaddressclaims API
+          properties:
+            apiVersion:
+              description: |-
+                APIVersion defines the versioned schema of this representation of an object.
+                Servers should convert recognized schemas to the latest internal value, and
+                may reject unrecognized values.
+                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+              type: string
+            kind:
+              description: |-
+                Kind is a string value representing the REST resource this object represents.
+                Servers may infer this from the endpoint the client submits requests to.
+                Cannot be updated.
+                In CamelCase.
+                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+              type: string
+            metadata:
+              type: object
+            spec:
+              description: IpAddressClaimSpec defines the desired state of IpAddressClaim
+              properties:
+                comments:
+                  type: string
+                customFields:
+                  additionalProperties:
+                    type: string
+                  type: object
+                description:
+                  type: string
+                parentPrefix:
+                  format: cidr
+                  type: string
+                  x-kubernetes-validations:
+                    - message: Field 'parentPrefix' is immutable
+                      rule: self == oldSelf
+                preserveInNetbox:
+                  type: boolean
+                tenant:
+                  type: string
+                  x-kubernetes-validations:
+                    - message: Field 'tenant' is immutable
+                      rule: self == oldSelf
+              required:
+                - parentPrefix
+              type: object
+            status:
+              description: IpAddressClaimStatus defines the observed state of IpAddressClaim
+              properties:
+                conditions:
+                  items:
+                    description:
+                      "Condition contains details for one aspect of the current
+                      state of this API Resource.\n---\nThis struct is intended for
+                      direct use as an array at the field path .status.conditions.  For
+                      example,\n\n\n\ttype FooStatus struct{\n\t    // Represents the
+                      observations of a foo's current state.\n\t    // Known .status.conditions.type
+                      are: \"Available\", \"Progressing\", and \"Degraded\"\n\t    //
+                      +patchMergeKey=type\n\t    // +patchStrategy=merge\n\t    // +listType=map\n\t
+                      \   // +listMapKey=type\n\t    Conditions []metav1.Condition `json:\"conditions,omitempty\"
+                      patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
+                      \   // other fields\n\t}"
+                    properties:
+                      lastTransitionTime:
+                        description: |-
+                          lastTransitionTime is the last time the condition transitioned from one status to another.
+                          This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+                        format: date-time
+                        type: string
+                      message:
+                        description: |-
+                          message is a human readable message indicating details about the transition.
+                          This may be an empty string.
+                        maxLength: 32768
+                        type: string
+                      observedGeneration:
+                        description: |-
+                          observedGeneration represents the .metadata.generation that the condition was set based upon.
+                          For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                          with respect to the current state of the instance.
+                        format: int64
+                        minimum: 0
+                        type: integer
+                      reason:
+                        description: |-
+                          reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                          Producers of specific condition types may define expected values and meanings for this field,
+                          and whether the values are considered a guaranteed API.
+                          The value should be a CamelCase string.
+                          This field may not be empty.
+                        maxLength: 1024
+                        minLength: 1
+                        pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                        type: string
+                      status:
+                        description: status of the condition, one of True, False, Unknown.
+                        enum:
+                          - "True"
+                          - "False"
+                          - Unknown
+                        type: string
+                      type:
+                        description: |-
+                          type of condition in CamelCase or in foo.example.com/CamelCase.
+                          ---
+                          Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
+                          useful (see .node.status.conditions), the ability to deconflict is important.
+                          The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+                        maxLength: 316
+                        pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                        type: string
+                    required:
+                      - lastTransitionTime
+                      - message
+                      - reason
+                      - status
+                      - type
+                    type: object
+                  type: array
+                ipAddress:
+                  type: string
+                ipAddressDotDecimal:
+                  type: string
+                ipAddressName:
+                  type: string
+              type: object
+          type: object
+      served: true
+      storage: true
+      subresources:
+        status: {}