-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add docs generation and validation (#9)
- Loading branch information
Showing
13 changed files
with
312 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| charts/**/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| HELM_DOCS_PACKAGE_VERSION := latest | ||
| KUBE_LINTER_PACKAGE_VERSION := latest | ||
| KUBECONFORM_PACKAGE_VERSION := latest | ||
|
|
||
| SHELL := bash | ||
| GO ?= go | ||
|
|
||
| HELM_DOCS_PACKAGE ?= github.com/norwoodj/helm-docs/cmd/helm-docs@$(HELM_DOCS_PACKAGE_VERSION) | ||
| KUBE_LINTER_PACKAGE ?= golang.stackrox.io/kube-linter/cmd/kube-linter@$(KUBE_LINTER_PACKAGE_VERSION) | ||
| KUBECONFORM_PACKAGE ?= github.com/yannh/kubeconform/cmd/kubeconform@$(KUBECONFORM_PACKAGE_VERSION) | ||
|
|
||
| all: docs lint api clean | ||
|
|
||
| .PHONY: docs | ||
| docs: | ||
| $(GO) run $(HELM_DOCS_PACKAGE) --badge-style=flat --template-files ci/README.md.gotmpl --output-file=README.md | ||
|
|
||
| .PHONY: ci-template | ||
| ci-template: | ||
| helm template charts/owncloud -f ci/ci-values.yaml > ci/owncloud-ci-templated.yaml | ||
|
|
||
| .PHONY: clean | ||
| clean: | ||
| @rm ci/owncloud-ci-templated.yaml | ||
|
|
||
| .PHONY: lint | ||
| lint: ci-template | ||
| helm lint charts/owncloud | ||
| $(GO) run $(KUBE_LINTER_PACKAGE) lint ci/owncloud-ci-templated.yaml | ||
|
|
||
| .PHONY: api | ||
| api: ci-template | ||
| $(GO) run $(KUBECONFORM_PACKAGE) -kubernetes-version 1.21.0 -summary -strict ci/owncloud-ci-templated.yaml | ||
| $(GO) run $(KUBECONFORM_PACKAGE) -kubernetes-version 1.22.0 -summary -strict ci/owncloud-ci-templated.yaml | ||
| $(GO) run $(KUBECONFORM_PACKAGE) -kubernetes-version 1.23.0 -summary -strict ci/owncloud-ci-templated.yaml | ||
| $(GO) run $(KUBECONFORM_PACKAGE) -kubernetes-version 1.24.0 -summary -strict ci/owncloud-ci-templated.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # owncloud | ||
|
|
||
|    | ||
|
|
||
| ownCloud Server Helm chart | ||
| **Homepage:** <https://owncloud.com/> | ||
| ## Source Code | ||
|
|
||
| * <https://github.com/owncloud-docker/helm-charts> | ||
| * <https://github.com/owncloud-docker/server> | ||
| * <https://github.com/owncloud/core> | ||
| ## Requirements | ||
|
|
||
| Kubernetes: `~1.21.0 || ~1.22.0 || ~1.23.0 || ~1.24.0 || ~1.25.0` | ||
|
|
||
| ## Values | ||
|
|
||
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | affinity | object | `{}` | Node affinity selection constraint. | | ||
| | autoscaling.enabled | bool | `false` | Enables autoscaling. When set to `true`, `replicas` is no longer applied. | | ||
| | autoscaling.maxReplicas | int | `10` | Sets maximum replicas for autoscaling. | | ||
| | autoscaling.metrics | list | `[]` | Metrics to use for autoscaling. | | ||
| | autoscaling.minReplicas | int | `1` | Sets minimum replicas for autoscaling. | | ||
| | externalDatabase.host | string | `""` | | | ||
| | externalDatabase.name | string | `"owncloud"` | | | ||
| | externalDatabase.password | string | `"owncloud"` | | | ||
| | externalDatabase.port | int | `3306` | | | ||
| | externalDatabase.type | string | `""` | | | ||
| | externalDatabase.user | string | `"owncloud"` | | | ||
| | fullnameOverride | string | `""` | | | ||
| | image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | | ||
| | image.repository | string | `"docker.io/owncloud/server"` | Image repository | | ||
| | image.sha | string | `""` | Image sha/digest (optional). | | ||
| | image.tag | string | The `appVersion` of the Chart. | Image tag. | | ||
| | imagePullSecrets | object | `{}` | List of references to secrets in the same namespace to use for pulling images from a private registry. | | ||
| | ingress.annotations | object | `{}` | Ingress annotations. | | ||
| | ingress.enabled | bool | `false` | Enables the Ingress. | | ||
| | ingress.ingressClassName | string | `""` | Ingress class to use. Uses the default ingress class if not set. | | ||
| | ingress.labels | object | `{}` | Labels for the ingress. | | ||
| | ingress.tls | list | `[]` | Ingress TLS configuration. | | ||
| | initResources | object | `{}` | Resources to apply to all init containers. | | ||
| | mariadb.enabled | bool | `false` | | | ||
| | nameOverride | string | `""` | | | ||
| | nodeSelector | object | `{}` | Simple node selection constraint. | | ||
| | owncloud.configExtra | object | `{}` | | | ||
| | owncloud.domain | string | `"owncloud.chart.example"` | | | ||
| | owncloud.password | string | `"owncloud"` | | | ||
| | owncloud.username | string | `"owncloud"` | | | ||
| | owncloud.volume_apps | string | `"/mnt/data/apps"` | | | ||
| | owncloud.volume_config | string | `"/mnt/data/config"` | | | ||
| | owncloud.volume_files | string | `"/mnt/data/files"` | | | ||
| | owncloud.volume_root | string | `"/mnt/data"` | | | ||
| | persistence.enabled | bool | `true` | Enables persistence. | | ||
| | persistence.owncloud.accessMode[0] | string | `"ReadWriteOnce"` | | | ||
| | persistence.owncloud.nfs | object | `{}` | | | ||
| | persistence.owncloud.size | string | `"20Gi"` | | | ||
| | podAnnotations | object | `{}` | Annotations to attach metadata to the Pod. | | ||
| | podSecurityContext | object | `{}` | Security settings for the Pod. | | ||
| | redis.enabled | bool | `false` | | | ||
| | replicas | int | `1` | Number of replicas for each scalable service. Has no effect when `autoscaling.enabled` is set to `true`. | | ||
| | resources | object | `{}` | Resources to apply to all services. | | ||
| | securityContext | object | `{"readOnlyRootFilesystem":false}` | Security settings for the Container. | | ||
| | securityContext.readOnlyRootFilesystem | bool | `false` | Mounts the container's root filesystem as read-only. Currently only `false` is supported by ownCloud 10. | | ||
| | service.port | int | `8080` | | | ||
| | service.type | string | `"LoadBalancer"` | | | ||
| | serviceAccount.annotations | object | `{}` | Annotations to add to the service account. | | ||
| | serviceAccount.create | bool | `true` | Specifies whether a service account should be created or not. | | ||
| | serviceAccount.name | string | `""` | The name of the service account to use. If not set and `create` is set to `true`, a name is generated using the fullname template. | | ||
| | tolerations | list | `[]` | Tolerations are applied to pods and allow the scheduler to schedule pods with matching taints. One or more taints need to be applied to a node to instruct this node to not accept any pods that do not tolerate the taints. | | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Configure OpenID Connect | ||
|
|
||
| To configure OpenID Connect the configExtra object can be used. | ||
|
|
||
| ```YAML | ||
| configExtra: | ||
| openid-connect: | ||
| auto-provision: | ||
| enabled: true | ||
| email-claim: "email" | ||
| display-name-claim: "given_name" | ||
| picture-claim: "picture" | ||
| provider-url: "https://example.com" | ||
| client-id: "myclientid" | ||
| client-secret: "mysecret" | ||
| autoRedirectOnLoginPage: false | ||
| mode: "email" | ||
| scopes: [] | ||
| use-access-token-payload-for-user-info: false | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.