From fd9e0e114051adec575aef09c67f345bb7bef284 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Mon, 16 Dec 2024 17:15:44 +0000 Subject: [PATCH] Migrate from frigate to sphinx-helm --- .pre-commit-config.yaml | 6 +- .../operator/deployment/helm/README.md | 4 +- .../helm/dask-kubernetes-operator/README.md | 66 +------------------ docs/requirements-docs.txt | 2 +- docs/source/conf.py | 2 +- docs/source/installing.rst | 2 +- 6 files changed, 9 insertions(+), 73 deletions(-) mode change 120000 => 100644 dask_kubernetes/operator/deployment/helm/README.md diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ebc658db8..8688e0aee 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,10 +10,6 @@ repos: - id: black language_version: python3 exclude: versioneer.py - - repo: https://github.com/rapidsai/frigate/ - rev: v0.4.0 # pre-commit autoupdate - to keep the version up to date - hooks: - - id: frigate - repo: local hooks: - id: check-crd-updates @@ -50,4 +46,4 @@ repos: |go\.sum |dask_kubernetes/operator/go_client/.*\.go )$ - pass_filenames: false \ No newline at end of file + pass_filenames: false diff --git a/dask_kubernetes/operator/deployment/helm/README.md b/dask_kubernetes/operator/deployment/helm/README.md deleted file mode 120000 index 599400690..000000000 --- a/dask_kubernetes/operator/deployment/helm/README.md +++ /dev/null @@ -1 +0,0 @@ -dask-kubernetes-operator/README.md \ No newline at end of file diff --git a/dask_kubernetes/operator/deployment/helm/README.md b/dask_kubernetes/operator/deployment/helm/README.md new file mode 100644 index 000000000..c2c5650dc --- /dev/null +++ b/dask_kubernetes/operator/deployment/helm/README.md @@ -0,0 +1,3 @@ +# Dask Operator Helm Chart + +See the [documentation](https://kubernetes.dask.org/en/latest/installing.html#operator) for installation information. diff --git a/dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator/README.md b/dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator/README.md index 02bcacec6..c2c5650dc 100644 --- a/dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator/README.md +++ b/dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator/README.md @@ -1,65 +1,3 @@ +# Dask Operator Helm Chart -Dask-kubernetes-operator -=========== - -A helm chart for managing the deployment of the dask kubernetes operator and CRDs - - -## Configuration - -The following table lists the configurable parameters of the Dask-kubernetes-operator chart and their default values. - -| Parameter | Description | Default | -| ------------------------ | ----------------------- | -------------- | -| `image.name` | Docker image for the operator | `"ghcr.io/dask/dask-kubernetes-operator"` | -| `image.tag` | Release version | `"set-by-chartpress"` | -| `image.pullPolicy` | Pull policy | `"IfNotPresent"` | -| `imagePullSecrets` | Image pull secrets for private registries | `[]` | -| `nameOverride` | Override release name (not including random UUID) | `""` | -| `fullnameOverride` | Override full release name | `""` | -| `serviceAccount.create` | Create a service account for the operator to use | `true` | -| `serviceAccount.annotations` | Annotations to add to the service account | `{}` | -| `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template. | `""` | -| `rbac.create` | Create a Role/ClusterRole needed by the operator and bind it to the service account | `true` | -| `rbac.cluster` | Creates a ClusterRole if true, else create a namespaced Role | `true` | -| `podAnnotations` | Extra annotations for the operator pod | `{}` | -| `podSecurityContext` | Security context for the operator pod | `{}` | -| `securityContext.capabilities.drop` | | `["ALL"]` | -| `securityContext.runAsNonRoot` | | `true` | -| `securityContext.runAsUser` | | `1000` | -| `securityContext.allowPrivilegeEscalation` | | `false` | -| `securityContext.readOnlyRootFilesystem` | | `true` | -| `resources` | Resources for the operator pod | `{}` | -| `volumes` | Volumes for the operator pod | `[]` | -| `volumeMounts` | Volume mounts for the operator container | `[]` | -| `nodeSelector` | Node selector | `{}` | -| `tolerations` | Tolerations | `[]` | -| `affinity` | Affinity | `{}` | -| `priorityClassName` | Priority class | `null` | -| `livenessProbe.timeoutSeconds` | | `5` | -| `kopfArgs` | Command line flags to pass to kopf on start up | `["--all-namespaces"]` | -| `metrics.scheduler.enabled` | Enable scheduler metrics. Pip package [prometheus-client](https://pypi.org/project/prometheus-client/) should be present on scheduler. | `false` | -| `metrics.scheduler.serviceMonitor.enabled` | Enable scheduler servicemonitor. | `false` | -| `metrics.scheduler.serviceMonitor.namespace` | Deploy servicemonitor in different namespace, e.g. monitoring. | `""` | -| `metrics.scheduler.serviceMonitor.namespaceSelector` | Selector to select which namespaces the Endpoints objects are discovered from. | `{}` | -| `metrics.scheduler.serviceMonitor.additionalLabels` | Additional labels to add to the ServiceMonitor metadata. | `{}` | -| `metrics.scheduler.serviceMonitor.interval` | Interval at which metrics should be scraped. | `"15s"` | -| `metrics.scheduler.serviceMonitor.jobLabel` | The label to use to retrieve the job name from. | `""` | -| `metrics.scheduler.serviceMonitor.targetLabels` | TargetLabels transfers labels on the Kubernetes Service onto the target. | `["dask.org/cluster-name"]` | -| `metrics.scheduler.serviceMonitor.metricRelabelings` | MetricRelabelConfigs to apply to samples before ingestion. | `[]` | -| `metrics.worker.enabled` | Enable workers metrics. Pip package [prometheus-client](https://pypi.org/project/prometheus-client/) should be present on workers. | `false` | -| `metrics.worker.podMonitor.enabled` | Enable workers podmonitor | `false` | -| `metrics.worker.podMonitor.namespace` | Deploy podmonitor in different namespace, e.g. monitoring. | `""` | -| `metrics.worker.podMonitor.namespaceSelector` | Selector to select which namespaces the Endpoints objects are discovered from. | `{}` | -| `metrics.worker.podMonitor.additionalLabels` | Additional labels to add to the PodMonitor metadata. | `{}` | -| `metrics.worker.podMonitor.interval` | Interval at which metrics should be scraped. | `"15s"` | -| `metrics.worker.podMonitor.jobLabel` | The label to use to retrieve the job name from. | `""` | -| `metrics.worker.podMonitor.podTargetLabels` | PodTargetLabels transfers labels on the Kubernetes Pod onto the target. | `["dask.org/cluster-name", "dask.org/workergroup-name"]` | -| `metrics.worker.podMonitor.metricRelabelings` | MetricRelabelConfigs to apply to samples before ingestion. | `[]` | -| `workerAllocation.size` | | `null` | -| `workerAllocation.delay` | | `null` | - - - ---- -_Documentation generated by [Frigate](https://frigate.readthedocs.io)._ +See the [documentation](https://kubernetes.dask.org/en/latest/installing.html#operator) for installation information. diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e55c5484e..ea70dbe00 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -3,7 +3,7 @@ sphinx sphinx-reredirects sphinxcontrib-mermaid dask-sphinx-theme>=3.0.0 -frigate>=0.7.0 +sphinx-helm # FIXME: This workaround is required until we have sphinx>=5, as enabled by # dask-sphinx-theme no longer pinning sphinx-book-theme==0.2.0. This is diff --git a/docs/source/conf.py b/docs/source/conf.py index 2647d67c5..821fe85aa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,7 +43,7 @@ "numpydoc", "sphinx_reredirects", "sphinxcontrib.mermaid", - "frigate.sphinx.ext", + "sphinx_helm.ext", ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 804158ffd..a1d383aa7 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -147,7 +147,7 @@ If you're using the official Dask images you can install this at runtime. Chart Configuration Reference """"""""""""""""""""""""""""" -.. frigate:: ../../dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator +.. helm:: ../../dask_kubernetes/operator/deployment/helm/dask-kubernetes-operator Installing with Manifests ^^^^^^^^^^^^^^^^^^^^^^^^^