forked from elastic/crd-ref-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add method to get kinds sorted * Add test script * Simplify sort kinds
- Loading branch information
1 parent
235188f
commit be60e15
Showing
20 changed files
with
1,243 additions
and
13 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
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,42 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Licensed to Elasticsearch B.V. under one or more contributor | ||
| # license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright | ||
| # ownership. Elasticsearch B.V. licenses this file to you under | ||
| # the Apache License, Version 2.0 (the "License"); you may | ||
| # not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| # Script to test the output of crd-ref-docs | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
|
|
||
| TEMP_DIR=$(mktemp -d -t crd-ref-docs-XXXXX) | ||
| trap '[[ $TEMP_DIR ]] && rm -rf "$TEMP_DIR"' EXIT | ||
|
|
||
|
|
||
| ( | ||
| cd "$SCRIPT_DIR" | ||
| go run main.go --log-level=ERROR --source-path="${SCRIPT_DIR}/test" --renderer=asciidoctor --templates-dir="${SCRIPT_DIR}/templates/asciidoctor" --output-path="${TEMP_DIR}/out.asciidoc" | ||
| DIFF=$(diff -a -y --suppress-common-lines "${SCRIPT_DIR}/test/expected.asciidoc" "${TEMP_DIR}/out.asciidoc") || true | ||
| if [ "$DIFF" ]; then | ||
| echo "ERROR: outputs differ" | ||
| echo "" | ||
| echo "$DIFF" | ||
| exit 1 | ||
| else | ||
| echo "OK" | ||
| fi | ||
| ) |
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,24 @@ | ||
|
|
||
| # Binaries for programs and plugins | ||
| *.exe | ||
| *.exe~ | ||
| *.dll | ||
| *.so | ||
| *.dylib | ||
| bin | ||
|
|
||
| # Test binary, build with `go test -c` | ||
| *.test | ||
|
|
||
| # Output of the go coverage tool, specifically when used with LiteIDE | ||
| *.out | ||
|
|
||
| # Kubernetes Generated files - skip generated files, except for vendored files | ||
|
|
||
| !vendor/**/zz_generated.* | ||
|
|
||
| # editor and IDE paraphernalia | ||
| .idea | ||
| *.swp | ||
| *.swo | ||
| *~ |
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,80 @@ | ||
|
|
||
| # Image URL to use all building/pushing image targets | ||
| IMG ?= controller:latest | ||
| # Produce CRDs that work back to Kubernetes 1.11 (no version conversion) | ||
| CRD_OPTIONS ?= "crd:trivialVersions=true" | ||
|
|
||
| # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) | ||
| ifeq (,$(shell go env GOBIN)) | ||
| GOBIN=$(shell go env GOPATH)/bin | ||
| else | ||
| GOBIN=$(shell go env GOBIN) | ||
| endif | ||
|
|
||
| all: manager | ||
|
|
||
| # Run tests | ||
| test: generate fmt vet manifests | ||
| go test ./... -coverprofile cover.out | ||
|
|
||
| # Build manager binary | ||
| manager: generate fmt vet | ||
| go build -o bin/manager main.go | ||
|
|
||
| # Run against the configured Kubernetes cluster in ~/.kube/config | ||
| run: generate fmt vet manifests | ||
| go run ./main.go | ||
|
|
||
| # Install CRDs into a cluster | ||
| install: manifests | ||
| kustomize build config/crd | kubectl apply -f - | ||
|
|
||
| # Uninstall CRDs from a cluster | ||
| uninstall: manifests | ||
| kustomize build config/crd | kubectl delete -f - | ||
|
|
||
| # Deploy controller in the configured Kubernetes cluster in ~/.kube/config | ||
| deploy: manifests | ||
| cd config/manager && kustomize edit set image controller=${IMG} | ||
| kustomize build config/default | kubectl apply -f - | ||
|
|
||
| # Generate manifests e.g. CRD, RBAC etc. | ||
| manifests: controller-gen | ||
| $(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases | ||
|
|
||
| # Run go fmt against code | ||
| fmt: | ||
| go fmt ./... | ||
|
|
||
| # Run go vet against code | ||
| vet: | ||
| go vet ./... | ||
|
|
||
| # Generate code | ||
| generate: controller-gen | ||
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." | ||
|
|
||
| # Build the docker image | ||
| docker-build: test | ||
| docker build . -t ${IMG} | ||
|
|
||
| # Push the docker image | ||
| docker-push: | ||
| docker push ${IMG} | ||
|
|
||
| # find or download controller-gen | ||
| # download controller-gen if necessary | ||
| controller-gen: | ||
| ifeq (, $(shell which controller-gen)) | ||
| @{ \ | ||
| set -e ;\ | ||
| CONTROLLER_GEN_TMP_DIR=$$(mktemp -d) ;\ | ||
| cd $$CONTROLLER_GEN_TMP_DIR ;\ | ||
| go mod init tmp ;\ | ||
| go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.2.5 ;\ | ||
| rm -rf $$CONTROLLER_GEN_TMP_DIR ;\ | ||
| } | ||
| CONTROLLER_GEN=$(GOBIN)/controller-gen | ||
| else | ||
| CONTROLLER_GEN=$(shell which controller-gen) | ||
| endif |
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,7 @@ | ||
| domain: test.k8s.elastic.co | ||
| repo: github.com/elastic/crd-ref-docs | ||
| resources: | ||
| - group: webapp | ||
| kind: Guestbook | ||
| version: v1 | ||
| version: "2" |
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,37 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| // Package v1 contains API Schema definitions for the webapp v1 API group | ||
| // +kubebuilder:object:generate=true | ||
| // +groupName=webapp.test.k8s.elastic.co | ||
| package v1 | ||
|
|
||
| import ( | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| "sigs.k8s.io/controller-runtime/pkg/scheme" | ||
| ) | ||
|
|
||
| var ( | ||
| // GroupVersion is group version used to register these objects | ||
| GroupVersion = schema.GroupVersion{Group: "webapp.test.k8s.elastic.co", Version: "v1"} | ||
|
|
||
| // SchemeBuilder is used to add go types to the GroupVersionKind scheme | ||
| SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} | ||
|
|
||
| // AddToScheme adds the types in this group-version to the given scheme. | ||
| AddToScheme = SchemeBuilder.AddToScheme | ||
| ) |
Oops, something went wrong.