-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add CRD docs * change doc name
- Loading branch information
Showing
6 changed files
with
242 additions
and
45 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ IMAGE_REPOSITORY := plural | |
| IMG ?= deployment-agent:latest | ||
|
|
||
| ENVTEST ?= $(shell which setup-envtest) | ||
| CRDDOCS ?= $(shell which crd-ref-docs) | ||
|
|
||
| VELERO_CHART_VERSION := 5.2.2 # It should be kept in sync with Velero chart version from console/charts/velero | ||
| VELERO_CHART_URL := https://github.com/vmware-tanzu/helm-charts/releases/download/velero-$(VELERO_CHART_VERSION)/velero-$(VELERO_CHART_VERSION).tgz | ||
|
|
@@ -37,6 +38,10 @@ help: ## Display this help. | |
| controller-gen: ## Download controller-gen locally if necessary. | ||
| $(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected]) | ||
|
|
||
| .PHONY: crd-docs | ||
| crd-docs: ##generate docs from the CRDs | ||
| $(CRDDOCS) --source-path=./api --renderer=markdown --output-path=./docs/api.md --config=config.yaml | ||
|
|
||
| ##@ Development | ||
|
|
||
| .PHONY: manifests | ||
|
|
@@ -119,6 +124,10 @@ envtest: --tool ## Download and install setup-envtest in the $GOPATH/bin | |
| mockery: TOOL = mockery | ||
| mockery: --tool | ||
|
|
||
| .PHONY: crd-ref-docs | ||
| crd-ref-docs: TOOL = crd-ref-docs | ||
| crd-ref-docs: --tool | ||
|
|
||
| # go-get-tool will 'go get' any package $2 and install it to $1. | ||
| PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST)))) | ||
| define go-get-tool | ||
|
|
||
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,22 @@ | ||
| processor: | ||
| ignoreTypes: | ||
| - ".*List$" | ||
| ignoreFields: | ||
| - "status$" | ||
| - "TypeMeta$" | ||
|
|
||
| render: | ||
| kubernetesVersion: 1.29 | ||
| knownTypes: | ||
| - name: SecretObjectReference | ||
| package: sigs.k8s.io/gateway-api/apis/v1beta1 | ||
| link: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.SecretObjectReference | ||
| - name: ObjectReference | ||
| package: k8s.io/api/core/v1 | ||
| link: https://pkg.go.dev/k8s.io/api/core/v1#ObjectReference | ||
| - name: ObjectMeta | ||
| package: k8s.io/apimachinery/pkg/apis/meta/v1 | ||
| link: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta | ||
| - name: RawExtension | ||
| package: k8s.io/apimachinery/pkg/runtime | ||
| link: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension |
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,141 @@ | ||
| # API Reference | ||
|
|
||
| ## Packages | ||
| - [deployments.plural.sh/v1alpha1](#deploymentspluralshv1alpha1) | ||
|
|
||
|
|
||
| ## deployments.plural.sh/v1alpha1 | ||
|
|
||
| Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group | ||
|
|
||
| ### Resource Types | ||
| - [CustomHealth](#customhealth) | ||
| - [PipelineGate](#pipelinegate) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| #### CustomHealth | ||
|
|
||
|
|
||
|
|
||
| CustomHealth is the Schema for the HealthConverts API | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | | | ||
| | `kind` _string_ | `CustomHealth` | | | | ||
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | ||
| | `spec` _[CustomHealthSpec](#customhealthspec)_ | | | | | ||
|
|
||
|
|
||
| #### CustomHealthSpec | ||
|
|
||
|
|
||
|
|
||
| CustomHealthSpec defines the desired state of CustomHealth | ||
|
|
||
|
|
||
|
|
||
| _Appears in:_ | ||
| - [CustomHealth](#customhealth) | ||
|
|
||
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `script` _string_ | | | | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| #### GateSpec | ||
|
|
||
|
|
||
|
|
||
| GateSpec defines the detailed gate specifications | ||
|
|
||
|
|
||
|
|
||
| _Appears in:_ | ||
| - [PipelineGateSpec](#pipelinegatespec) | ||
|
|
||
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `job` _[JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#jobspec-v1-batch)_ | resuse JobSpec type from the kubernetes api | | | | ||
|
|
||
|
|
||
| #### GateState | ||
|
|
||
| _Underlying type:_ _GateState_ | ||
|
|
||
| GateState represents the state of a gate, reused from console client | ||
|
|
||
| _Validation:_ | ||
| - Enum: [PENDING OPEN CLOSED RUNNING] | ||
|
|
||
| _Appears in:_ | ||
| - [PipelineGateStatus](#pipelinegatestatus) | ||
|
|
||
|
|
||
|
|
||
| #### GateType | ||
|
|
||
| _Underlying type:_ _GateType_ | ||
|
|
||
| GateType represents the type of a gate, reused from console client | ||
|
|
||
| _Validation:_ | ||
| - Enum: [APPROVAL WINDOW JOB] | ||
|
|
||
| _Appears in:_ | ||
| - [PipelineGateSpec](#pipelinegatespec) | ||
|
|
||
|
|
||
|
|
||
| #### PipelineGate | ||
|
|
||
|
|
||
|
|
||
| PipelineGate represents a gate blocking promotion along a release pipeline | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | | | ||
| | `kind` _string_ | `PipelineGate` | | | | ||
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | ||
| | `spec` _[PipelineGateSpec](#pipelinegatespec)_ | | | | | ||
|
|
||
|
|
||
| #### PipelineGateSpec | ||
|
|
||
|
|
||
|
|
||
| PipelineGateSpec defines the detailed gate specifications | ||
|
|
||
|
|
||
|
|
||
| _Appears in:_ | ||
| - [PipelineGate](#pipelinegate) | ||
|
|
||
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `id` _string_ | | | | | ||
| | `name` _string_ | | | | | ||
| | `type` _[GateType](#gatetype)_ | | | Enum: [APPROVAL WINDOW JOB] <br /> | | ||
| | `gateSpec` _[GateSpec](#gatespec)_ | | | | | ||
|
|
||
|
|
||
|
|
||
|
|
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.