From 07caa610d2e32ebcbc39a9038ce55da265c49265 Mon Sep 17 00:00:00 2001 From: Eric Stroczynski Date: Fri, 17 Jul 2020 13:13:58 -0700 Subject: [PATCH] *: remove legacy CLI docs, move new CLI docs to main CLI doc path --- hack/generate/cli-doc/gen-cli-doc.go | 13 +-- proposals/ansible-helm-addapi.md | 4 +- .../advanced-topics/scorecard/scorecard.md | 2 +- .../building-operators/ansible/quickstart.md | 4 +- .../golang/references/markers.md | 2 +- website/content/en/docs/cli/_index.md | 8 +- .../en/docs/cli/ansible-helm/_index.md | 18 --- .../en/docs/cli/ansible-helm/operator-sdk.md | 27 ----- .../docs/cli/ansible-helm/operator-sdk_add.md | 22 ---- .../cli/ansible-helm/operator-sdk_add_api.md | 103 ------------------ .../cli/ansible-helm/operator-sdk_build.md | 40 ------- .../ansible-helm/operator-sdk_completion.md | 23 ---- .../operator-sdk_completion_bash.md | 25 ----- .../operator-sdk_completion_zsh.md | 25 ----- .../docs/cli/ansible-helm/operator-sdk_new.md | 84 -------------- .../docs/cli/ansible-helm/operator-sdk_olm.md | 24 ---- .../ansible-helm/operator-sdk_olm_install.md | 28 ----- .../ansible-helm/operator-sdk_olm_status.md | 28 ----- .../operator-sdk_olm_uninstall.md | 28 ----- .../ansible-helm/operator-sdk_scorecard.md | 36 ------ .../cli/ansible-helm/operator-sdk_version.md | 25 ----- website/content/en/docs/cli/golang/_index.md | 9 -- .../en/docs/cli/{golang => }/operator-sdk.md | 0 .../cli/{golang => }/operator-sdk_build.md | 0 .../cli/{golang => }/operator-sdk_bundle.md | 0 .../operator-sdk_bundle_validate.md | 0 .../cli/{golang => }/operator-sdk_cleanup.md | 0 .../operator-sdk_cleanup_packagemanifests.md | 0 .../{golang => }/operator-sdk_completion.md | 0 .../operator-sdk_completion_bash.md | 0 .../operator-sdk_completion_zsh.md | 0 .../cli/{golang => }/operator-sdk_create.md | 0 .../{golang => }/operator-sdk_create_api.md | 0 .../operator-sdk_create_webhook.md | 0 .../cli/{golang => }/operator-sdk_generate.md | 0 .../operator-sdk_generate_bundle.md | 0 .../operator-sdk_generate_kustomize.md | 0 ...erator-sdk_generate_kustomize_manifests.md | 0 .../operator-sdk_generate_packagemanifests.md | 0 .../cli/{golang => }/operator-sdk_init.md | 0 .../docs/cli/{golang => }/operator-sdk_new.md | 0 .../docs/cli/{golang => }/operator-sdk_olm.md | 0 .../{golang => }/operator-sdk_olm_install.md | 0 .../{golang => }/operator-sdk_olm_status.md | 0 .../operator-sdk_olm_uninstall.md | 0 .../docs/cli/{golang => }/operator-sdk_run.md | 0 .../operator-sdk_run_packagemanifests.md | 0 .../{golang => }/operator-sdk_scorecard.md | 0 .../cli/{golang => }/operator-sdk_version.md | 0 .../en/docs/olm-integration/cli-overview.md | 16 +-- .../{generating-a-csv.md => generation.md} | 6 +- .../docs/olm-integration/quickstart-bundle.md | 4 +- .../quickstart-package-manifests.md | 6 +- .../olm-integration/testing-deployment.md | 4 +- 54 files changed, 32 insertions(+), 582 deletions(-) delete mode 100644 website/content/en/docs/cli/ansible-helm/_index.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_add.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_add_api.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_build.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_completion.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_completion_bash.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_completion_zsh.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_new.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_olm.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_olm_install.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_olm_status.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_olm_uninstall.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_scorecard.md delete mode 100644 website/content/en/docs/cli/ansible-helm/operator-sdk_version.md delete mode 100644 website/content/en/docs/cli/golang/_index.md rename website/content/en/docs/cli/{golang => }/operator-sdk.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_build.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_bundle.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_bundle_validate.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_cleanup.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_cleanup_packagemanifests.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_completion.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_completion_bash.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_completion_zsh.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_create.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_create_api.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_create_webhook.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_generate.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_generate_bundle.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_generate_kustomize.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_generate_kustomize_manifests.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_generate_packagemanifests.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_init.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_new.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_olm.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_olm_install.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_olm_status.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_olm_uninstall.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_run.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_run_packagemanifests.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_scorecard.md (100%) rename website/content/en/docs/cli/{golang => }/operator-sdk_version.md (100%) rename website/content/en/docs/olm-integration/{generating-a-csv.md => generation.md} (98%) diff --git a/hack/generate/cli-doc/gen-cli-doc.go b/hack/generate/cli-doc/gen-cli-doc.go index 9343782363..775eebb1e4 100644 --- a/hack/generate/cli-doc/gen-cli-doc.go +++ b/hack/generate/cli-doc/gen-cli-doc.go @@ -39,15 +39,10 @@ func main() { log.Fatalf("Failed to get current directory: %v", err) } - legacyDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "ansible-helm") - legacyRoot := cli.GetCLIRoot() - legacyRoot.DisableAutoGenTag = true - recreateDocDir(legacyRoot, legacyDocPath) - - newDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "golang") - _, newRoot := cli.GetPluginsCLIAndRoot() - newRoot.DisableAutoGenTag = true - recreateDocDir(newRoot, newDocPath) + cliDocsPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli") + _, cliRoot := cli.GetPluginsCLIAndRoot() + cliRoot.DisableAutoGenTag = true + recreateDocDir(cliRoot, cliDocsPath) } // htmlFormatter will replace angular brackets (`<` and `>`) with its character entitites diff --git a/proposals/ansible-helm-addapi.md b/proposals/ansible-helm-addapi.md index 567e7e794d..f2faed341c 100644 --- a/proposals/ansible-helm-addapi.md +++ b/proposals/ansible-helm-addapi.md @@ -257,8 +257,8 @@ and subsequently [`func doAnsibleScaffold()`][doansible] or [`func doHelmScaffol kind: Mykind role: /opt/ansible/roles/mykind ``` -[addapidoc]: https://sdk.operatorframework.io/docs/cli/operator-sdk_add_api/ -[sdkclidoc]: https://sdk.operatorframework.io/docs/cli/ +[addapidoc]: https://v0-19-x.sdk.operatorframework.io/docs/cli/operator-sdk_add_api/ +[sdkclidoc]: https://v0-19-x.sdk.operatorframework.io/docs/cli/ [onlygorestriction]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/add/api.go#L95 [doansible]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/new/cmd.go#L228 [dohelm]:https://github.com/operator-framework/operator-sdk/blob/master/cmd/operator-sdk/new/cmd.go#L320 diff --git a/website/content/en/docs/advanced-topics/scorecard/scorecard.md b/website/content/en/docs/advanced-topics/scorecard/scorecard.md index 54340cb569..1a81d3b2f8 100644 --- a/website/content/en/docs/advanced-topics/scorecard/scorecard.md +++ b/website/content/en/docs/advanced-topics/scorecard/scorecard.md @@ -254,7 +254,7 @@ Writing custom tests in other programming languages is possible if the test image follows the above guidelines. -[cli-scorecard]: /docs/cli/golang/operator-sdk_scorecard/ +[cli-scorecard]: /docs/cli/operator-sdk_scorecard/ [sample-config]: https://github.com/operator-framework/operator-sdk/blob/master/internal/scorecard/testdata/bundle/tests/scorecard/config.yaml [custom-image]: https://github.com/operator-framework/operator-sdk/blob/master/internal/scorecard/examples/custom-scorecard-tests [scorecard-struct]: https://github.com/operator-framework/operator-sdk/blob/master/pkg/apis/scorecard/v1alpha3/types.go diff --git a/website/content/en/docs/building-operators/ansible/quickstart.md b/website/content/en/docs/building-operators/ansible/quickstart.md index 3901d0f068..b78b9be187 100644 --- a/website/content/en/docs/building-operators/ansible/quickstart.md +++ b/website/content/en/docs/building-operators/ansible/quickstart.md @@ -376,6 +376,6 @@ For more information, refer [cli][addcli] doc. [go-tool]:https://golang.org/dl/ [docker-tool]:https://docs.docker.com/install/ [kubectl-tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/ -[addcli]: /docs/cli/ansible-helm/operator-sdk_add_api - + +[addcli]: https://v0-19-x.sdk.operatorframework.io/docs/cli/operator-sdk_add_api [quickstart-bundle]:https://v0-19-x.sdk.operatorframework.io/docs/olm-integration/legacy/quickstart-bundle/ diff --git a/website/content/en/docs/building-operators/golang/references/markers.md b/website/content/en/docs/building-operators/golang/references/markers.md index 530dd704a8..d737965cb4 100644 --- a/website/content/en/docs/building-operators/golang/references/markers.md +++ b/website/content/en/docs/building-operators/golang/references/markers.md @@ -204,6 +204,6 @@ customresourcedefinitions: [markers]:https://pkg.go.dev/sigs.k8s.io/controller-tools/pkg/markers [code-markers-design]:https://github.com/operator-framework/operator-sdk/blob/master/proposals/sdk-code-annotations.md -[cli-gen-kustomize-manifests]:/docs/cli/golang/operator-sdk_generate_kustomize_manifests +[cli-gen-kustomize-manifests]:/docs/cli/operator-sdk_generate_kustomize_manifests [csv-x-desc]:https://github.com/openshift/console/blob/feabd61/frontend/packages/operator-lifecycle-manager/src/components/descriptors/types.ts#L3-L39 [csv-spec]:https://github.com/operator-framework/operator-lifecycle-manager/blob/e0eea22/doc/design/building-your-csv.md diff --git a/website/content/en/docs/cli/_index.md b/website/content/en/docs/cli/_index.md index 247a6db8e1..3714c5697d 100644 --- a/website/content/en/docs/cli/_index.md +++ b/website/content/en/docs/cli/_index.md @@ -1,6 +1,6 @@ --- -title: Commands(CLI) -linkTitle: Commands(CLI) +title: Command Line Interface +linkTitle: Commands weight: 7 -description: Working with operator-sdk cli ---- \ No newline at end of file +description: Working with the operator-sdk CLI +--- diff --git a/website/content/en/docs/cli/ansible-helm/_index.md b/website/content/en/docs/cli/ansible-helm/_index.md deleted file mode 100644 index 06228285df..0000000000 --- a/website/content/en/docs/cli/ansible-helm/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Legacy CLI -weight: 1 -description: Working with operator-sdk cli for ansible/helm based operators ---- - -**Note:** For Golang Operators this CLI has been deprecated. Please consult the [new CLI reference][new_CLI] doc. - -[new_CLI]:/docs/cli/golang - - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk.md b/website/content/en/docs/cli/ansible-helm/operator-sdk.md deleted file mode 100644 index 56a5b345f2..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "operator-sdk" ---- -## operator-sdk - -An SDK for building operators with ease - -### Synopsis - -An SDK for building operators with ease - -### Options - -``` - -h, --help help for operator-sdk -``` - -### SEE ALSO - -* [operator-sdk add](../operator-sdk_add) - Adds a controller or resource to the project -* [operator-sdk build](../operator-sdk_build) - Compiles code and builds artifacts -* [operator-sdk completion](../operator-sdk_completion) - Generators for shell completions -* [operator-sdk new](../operator-sdk_new) - Creates a new operator application -* [operator-sdk olm](../operator-sdk_olm) - Manage the Operator Lifecycle Manager installation in your cluster -* [operator-sdk scorecard](../operator-sdk_scorecard) - Runs scorecard -* [operator-sdk version](../operator-sdk_version) - Prints the version of operator-sdk - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_add.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_add.md deleted file mode 100644 index 4201b3e3ae..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_add.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "operator-sdk add" ---- -## operator-sdk add - -Adds a controller or resource to the project - -### Synopsis - -Adds a controller or resource to the project - -### Options - -``` - -h, --help help for add -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease -* [operator-sdk add api](../operator-sdk_add_api) - Adds a new api definition under pkg/apis - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_add_api.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_add_api.md deleted file mode 100644 index 14aa786067..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_add_api.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "operator-sdk add api" ---- -## operator-sdk add api - -Adds a new api definition under pkg/apis - -### Synopsis - -operator-sdk add api --kind=<kind> --api-version<group/version> -creates an API definition for a new custom resource. -This command must be run from the project root directory. - -For Go-based operators: - - - Creates the api definition for a new custom resource under pkg/apis. - - By default, this command runs Kubernetes deepcopy and CRD generators on - tagged types in all paths under pkg/apis. Go code is generated under - pkg/apis/<group>/<version>/zz_generated.deepcopy.go. Generation can be disabled with the - --skip-generation flag for Go-based operators. - -For Ansible-based operators: - - - Creates resource folder under /roles. - - watches.yaml is updated with new resource. - - deploy/role.yaml will be updated with apiGroup for new API. - -For Helm-based operators: - - Creates resource folder under /helm-charts. - - watches.yaml is updated with new resource. - - deploy/role.yaml will be updated to reflact new rules for the incoming API. - -CRD's are generated, or updated if they exist for a particular group + version + kind, under -deploy/crds/<full group>_<resource>_crd.yaml; OpenAPI V3 validation YAML -is generated as a 'validation' object. - -``` -operator-sdk add api [flags] -``` - -### Examples - -``` - # Create a new API, under an existing project. This command must be run from the project root directory. -# Go Example: - $ operator-sdk add api --api-version=app.example.com/v1alpha1 --kind=AppService - -# Ansible Example - $ operator-sdk add api \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService - -# Helm Example: - $ operator-sdk add api \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService - - $ operator-sdk add api \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService - --helm-chart=myrepo/app - - $ operator-sdk add api \ - --helm-chart=myrepo/app - - $ operator-sdk add api \ - --helm-chart=myrepo/app \ - --helm-chart-version=1.2.3 - - $ operator-sdk add api \ - --helm-chart=app \ - --helm-chart-repo=https://charts.mycompany.com/ - - $ operator-sdk add api \ - --helm-chart=app \ - --helm-chart-repo=https://charts.mycompany.com/ \ - --helm-chart-version=1.2.3 - - $ operator-sdk add api \ - --helm-chart=/path/to/local/chart-directories/app/ - - $ operator-sdk add api \ - --helm-chart=/path/to/local/chart-archives/app-1.2.3.tgz - -``` - -### Options - -``` - --api-version string Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1) - --crd-version string CRD version to generate (default "v1") - --helm-chart string Initialize helm operator with existing helm chart (, /, or local path). Valid only for --type helm - --helm-chart-repo string Chart repository URL for the requested helm chart, Valid only for --type helm - --helm-chart-version string Specific version of the helm chart (default is latest version). Valid only for --type helm - -h, --help help for api - --kind string Kubernetes resource Kind name. (e.g AppService) - --skip-generation Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs -``` - -### SEE ALSO - -* [operator-sdk add](../operator-sdk_add) - Adds a controller or resource to the project - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_build.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_build.md deleted file mode 100644 index 8a29e7e1a7..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_build.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "operator-sdk build" ---- -## operator-sdk build - -Compiles code and builds artifacts - -### Synopsis - -The operator-sdk build command compiles the Operator code into an executable binary -and generates the Dockerfile manifest. - -'< image >' is the container image to be built, e.g. "quay.io/example/operator:v0.0.1". -This image will be automatically set in the deployment manifests. - -After build completes, the image would be built locally in docker. Then it needs to -be pushed to remote registry. -For example: - - $ operator-sdk build quay.io/example/operator:v0.0.1 - $ docker push quay.io/example/operator:v0.0.1 - - -``` -operator-sdk build [flags] -``` - -### Options - -``` - --go-build-args string Extra Go build arguments as one string such as "-ldflags -X=main.xyz=abc" - -h, --help help for build - --image-build-args string Extra image build arguments as one string such as "--build-arg https_proxy=$https_proxy" - --image-builder string Tool to build OCI images. One of: [docker, podman, buildah] (default "docker") -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_completion.md deleted file mode 100644 index 172acb76a5..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "operator-sdk completion" ---- -## operator-sdk completion - -Generators for shell completions - -### Synopsis - -Generators for shell completions - -### Options - -``` - -h, --help help for completion -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease -* [operator-sdk completion bash](../operator-sdk_completion_bash) - Generate bash completions -* [operator-sdk completion zsh](../operator-sdk_completion_zsh) - Generate zsh completions - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_bash.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_bash.md deleted file mode 100644 index 4003597111..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_bash.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "operator-sdk completion bash" ---- -## operator-sdk completion bash - -Generate bash completions - -### Synopsis - -Generate bash completions - -``` -operator-sdk completion bash [flags] -``` - -### Options - -``` - -h, --help help for bash -``` - -### SEE ALSO - -* [operator-sdk completion](../operator-sdk_completion) - Generators for shell completions - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_zsh.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_zsh.md deleted file mode 100644 index 12e2063ba0..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_completion_zsh.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "operator-sdk completion zsh" ---- -## operator-sdk completion zsh - -Generate zsh completions - -### Synopsis - -Generate zsh completions - -``` -operator-sdk completion zsh [flags] -``` - -### Options - -``` - -h, --help help for zsh -``` - -### SEE ALSO - -* [operator-sdk completion](../operator-sdk_completion) - Generators for shell completions - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_new.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_new.md deleted file mode 100644 index a0cc506fe4..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_new.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "operator-sdk new" ---- -## operator-sdk new - -Creates a new operator application - -### Synopsis - -The operator-sdk new command creates a new operator application and -generates a default directory layout based on the input <project-name>. - -<project-name> is the project name of the new operator. (e.g app-operator) - - -``` -operator-sdk new [flags] -``` - -### Examples - -``` - # Create a new project directory - $ mkdir $HOME/projects/example.com/ - $ cd $HOME/projects/example.com/ - - # Ansible project - $ operator-sdk new app-operator --type=ansible \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService - - # Helm project - $ operator-sdk new app-operator --type=helm \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService - - $ operator-sdk new app-operator --type=helm \ - --api-version=app.example.com/v1alpha1 \ - --kind=AppService \ - --helm-chart=myrepo/app - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=myrepo/app - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=myrepo/app \ - --helm-chart-version=1.2.3 - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=app \ - --helm-chart-repo=https://charts.mycompany.com/ - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=app \ - --helm-chart-repo=https://charts.mycompany.com/ \ - --helm-chart-version=1.2.3 - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=/path/to/local/chart-directories/app/ - - $ operator-sdk new app-operator --type=helm \ - --helm-chart=/path/to/local/chart-archives/app-1.2.3.tgz - -``` - -### Options - -``` - --api-version string Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1) - --crd-version string CRD version to generate (default "v1") - --generate-playbook Generate a playbook skeleton. (Only used for --type ansible) - --helm-chart string Initialize helm operator with existing helm chart (, /, or local path). Valid only for --type helm - --helm-chart-repo string Chart repository URL for the requested helm chart, Valid only for --type helm - --helm-chart-version string Specific version of the helm chart (default is latest version). Valid only for --type helm - -h, --help help for new - --kind string Kubernetes resource Kind name. (e.g AppService) - --skip-generation Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs - --type string Type of operator to initialize (choices: "ansible" or "helm") -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_olm.md deleted file mode 100644 index 23f013d10e..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "operator-sdk olm" ---- -## operator-sdk olm - -Manage the Operator Lifecycle Manager installation in your cluster - -### Synopsis - -Manage the Operator Lifecycle Manager installation in your cluster - -### Options - -``` - -h, --help help for olm -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease -* [operator-sdk olm install](../operator-sdk_olm_install) - Install Operator Lifecycle Manager in your cluster -* [operator-sdk olm status](../operator-sdk_olm_status) - Get the status of the Operator Lifecycle Manager installation in your cluster -* [operator-sdk olm uninstall](../operator-sdk_olm_uninstall) - Uninstall Operator Lifecycle Manager from your cluster - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_install.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_install.md deleted file mode 100644 index 18f8e7dc8d..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_install.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "operator-sdk olm install" ---- -## operator-sdk olm install - -Install Operator Lifecycle Manager in your cluster - -### Synopsis - -Install Operator Lifecycle Manager in your cluster - -``` -operator-sdk olm install [flags] -``` - -### Options - -``` - -h, --help help for install - --olm-namespace string namespace where OLM is to be installed. (default "olm") - --timeout duration time to wait for the command to complete before failing (default 2m0s) - --version string version of OLM resources to install (default "latest") -``` - -### SEE ALSO - -* [operator-sdk olm](../operator-sdk_olm) - Manage the Operator Lifecycle Manager installation in your cluster - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_status.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_status.md deleted file mode 100644 index a097376371..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_status.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "operator-sdk olm status" ---- -## operator-sdk olm status - -Get the status of the Operator Lifecycle Manager installation in your cluster - -### Synopsis - -Get the status of the Operator Lifecycle Manager installation in your cluster - -``` -operator-sdk olm status [flags] -``` - -### Options - -``` - -h, --help help for status - --olm-namespace string namespace where OLM is installed (default "olm") - --timeout duration time to wait for the command to complete before failing (default 2m0s) - --version string version of OLM installed on cluster; if unsetoperator-sdk attempts to auto-discover the version -``` - -### SEE ALSO - -* [operator-sdk olm](../operator-sdk_olm) - Manage the Operator Lifecycle Manager installation in your cluster - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_uninstall.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_uninstall.md deleted file mode 100644 index 8cebfd27ca..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_olm_uninstall.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "operator-sdk olm uninstall" ---- -## operator-sdk olm uninstall - -Uninstall Operator Lifecycle Manager from your cluster - -### Synopsis - -Uninstall Operator Lifecycle Manager from your cluster - -``` -operator-sdk olm uninstall [flags] -``` - -### Options - -``` - -h, --help help for uninstall - --olm-namespace string namespace from where OLM is to be uninstalled. (default "olm") - --timeout duration time to wait for the command to complete before failing (default 2m0s) - --version string version of OLM resources to uninstall. -``` - -### SEE ALSO - -* [operator-sdk olm](../operator-sdk_olm) - Manage the Operator Lifecycle Manager installation in your cluster - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_scorecard.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_scorecard.md deleted file mode 100644 index c5df090c3f..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_scorecard.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "operator-sdk scorecard" ---- -## operator-sdk scorecard - -Runs scorecard - -### Synopsis - -Has flags to configure dsl, bundle, and selector. This command takes -one argument, either a bundle image or directory containing manifests and metadata. -If the argument holds an image tag, it must be present remotely. - -``` -operator-sdk scorecard [flags] -``` - -### Options - -``` - -c, --config string path to scorecard config file - -h, --help help for scorecard - --kubeconfig string kubeconfig path - -L, --list Option to enable listing which tests are run - -n, --namespace string namespace to run the test images in (default "default") - -o, --output string Output format for results. Valid values: text, json (default "text") - -l, --selector string label selector to determine which tests are run - -s, --service-account string Service account to use for tests (default "default") - -x, --skip-cleanup Disable resource cleanup after tests are run - -w, --wait-time duration seconds to wait for tests to complete. Example: 35s (default 30s) -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease - diff --git a/website/content/en/docs/cli/ansible-helm/operator-sdk_version.md b/website/content/en/docs/cli/ansible-helm/operator-sdk_version.md deleted file mode 100644 index 89682896b2..0000000000 --- a/website/content/en/docs/cli/ansible-helm/operator-sdk_version.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "operator-sdk version" ---- -## operator-sdk version - -Prints the version of operator-sdk - -### Synopsis - -Prints the version of operator-sdk - -``` -operator-sdk version [flags] -``` - -### Options - -``` - -h, --help help for version -``` - -### SEE ALSO - -* [operator-sdk](../operator-sdk) - An SDK for building operators with ease - diff --git a/website/content/en/docs/cli/golang/_index.md b/website/content/en/docs/cli/golang/_index.md deleted file mode 100644 index 5f49d480ed..0000000000 --- a/website/content/en/docs/cli/golang/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: New CLI -weight: 2 -description: Working with operator-sdk cli for golang based operators ---- - -**Note:** This CLI reference is for the new Kubebuilder aligned CLI and project layout. See the [legacy CLI reference][legacy_cli] doc if using a legacy Golang project. - -[legacy_CLI]:/docs/cli/ansible-helm diff --git a/website/content/en/docs/cli/golang/operator-sdk.md b/website/content/en/docs/cli/operator-sdk.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk.md rename to website/content/en/docs/cli/operator-sdk.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_build.md b/website/content/en/docs/cli/operator-sdk_build.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_build.md rename to website/content/en/docs/cli/operator-sdk_build.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_bundle.md b/website/content/en/docs/cli/operator-sdk_bundle.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_bundle.md rename to website/content/en/docs/cli/operator-sdk_bundle.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_bundle_validate.md b/website/content/en/docs/cli/operator-sdk_bundle_validate.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_bundle_validate.md rename to website/content/en/docs/cli/operator-sdk_bundle_validate.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_cleanup.md b/website/content/en/docs/cli/operator-sdk_cleanup.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_cleanup.md rename to website/content/en/docs/cli/operator-sdk_cleanup.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_cleanup_packagemanifests.md b/website/content/en/docs/cli/operator-sdk_cleanup_packagemanifests.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_cleanup_packagemanifests.md rename to website/content/en/docs/cli/operator-sdk_cleanup_packagemanifests.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_completion.md b/website/content/en/docs/cli/operator-sdk_completion.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_completion.md rename to website/content/en/docs/cli/operator-sdk_completion.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_completion_bash.md b/website/content/en/docs/cli/operator-sdk_completion_bash.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_completion_bash.md rename to website/content/en/docs/cli/operator-sdk_completion_bash.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_completion_zsh.md b/website/content/en/docs/cli/operator-sdk_completion_zsh.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_completion_zsh.md rename to website/content/en/docs/cli/operator-sdk_completion_zsh.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_create.md b/website/content/en/docs/cli/operator-sdk_create.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_create.md rename to website/content/en/docs/cli/operator-sdk_create.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_create_api.md b/website/content/en/docs/cli/operator-sdk_create_api.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_create_api.md rename to website/content/en/docs/cli/operator-sdk_create_api.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_create_webhook.md b/website/content/en/docs/cli/operator-sdk_create_webhook.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_create_webhook.md rename to website/content/en/docs/cli/operator-sdk_create_webhook.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_generate.md b/website/content/en/docs/cli/operator-sdk_generate.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_generate.md rename to website/content/en/docs/cli/operator-sdk_generate.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_generate_bundle.md b/website/content/en/docs/cli/operator-sdk_generate_bundle.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_generate_bundle.md rename to website/content/en/docs/cli/operator-sdk_generate_bundle.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_generate_kustomize.md b/website/content/en/docs/cli/operator-sdk_generate_kustomize.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_generate_kustomize.md rename to website/content/en/docs/cli/operator-sdk_generate_kustomize.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_generate_kustomize_manifests.md b/website/content/en/docs/cli/operator-sdk_generate_kustomize_manifests.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_generate_kustomize_manifests.md rename to website/content/en/docs/cli/operator-sdk_generate_kustomize_manifests.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_generate_packagemanifests.md b/website/content/en/docs/cli/operator-sdk_generate_packagemanifests.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_generate_packagemanifests.md rename to website/content/en/docs/cli/operator-sdk_generate_packagemanifests.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_init.md b/website/content/en/docs/cli/operator-sdk_init.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_init.md rename to website/content/en/docs/cli/operator-sdk_init.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_new.md b/website/content/en/docs/cli/operator-sdk_new.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_new.md rename to website/content/en/docs/cli/operator-sdk_new.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_olm.md b/website/content/en/docs/cli/operator-sdk_olm.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_olm.md rename to website/content/en/docs/cli/operator-sdk_olm.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_olm_install.md b/website/content/en/docs/cli/operator-sdk_olm_install.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_olm_install.md rename to website/content/en/docs/cli/operator-sdk_olm_install.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_olm_status.md b/website/content/en/docs/cli/operator-sdk_olm_status.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_olm_status.md rename to website/content/en/docs/cli/operator-sdk_olm_status.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_olm_uninstall.md b/website/content/en/docs/cli/operator-sdk_olm_uninstall.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_olm_uninstall.md rename to website/content/en/docs/cli/operator-sdk_olm_uninstall.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_run.md b/website/content/en/docs/cli/operator-sdk_run.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_run.md rename to website/content/en/docs/cli/operator-sdk_run.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_run_packagemanifests.md b/website/content/en/docs/cli/operator-sdk_run_packagemanifests.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_run_packagemanifests.md rename to website/content/en/docs/cli/operator-sdk_run_packagemanifests.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_scorecard.md b/website/content/en/docs/cli/operator-sdk_scorecard.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_scorecard.md rename to website/content/en/docs/cli/operator-sdk_scorecard.md diff --git a/website/content/en/docs/cli/golang/operator-sdk_version.md b/website/content/en/docs/cli/operator-sdk_version.md similarity index 100% rename from website/content/en/docs/cli/golang/operator-sdk_version.md rename to website/content/en/docs/cli/operator-sdk_version.md diff --git a/website/content/en/docs/olm-integration/cli-overview.md b/website/content/en/docs/olm-integration/cli-overview.md index dce63a0e4f..52af83e203 100644 --- a/website/content/en/docs/olm-integration/cli-overview.md +++ b/website/content/en/docs/olm-integration/cli-overview.md @@ -45,12 +45,12 @@ with an existing OLM installation. [bundle]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md [package-manifests]:https://github.com/operator-framework/operator-registry/tree/v1.5.3#manifest-format -[doc-olm-generate]:/docs/olm-integration/generating-a-csv -[cli-olm-install]:/docs/cli/golang/operator-sdk_olm_install -[cli-olm-status]:/docs/cli/golang/operator-sdk_olm_status -[cli-olm-uninstall]:/docs/cli/golang/operator-sdk_olm_uninstall -[cli-gen-bundle]:/docs/cli/golang/operator-sdk_generate_bundle -[cli-gen-packagemanifests]:/docs/cli/golang/operator-sdk_generate_packagemanifests -[cli-gen-kustomize-manifests]:/docs/cli/golang/operator-sdk_generate_kustomize_manifests -[cli-bundle-validate]:/docs/cli/golang/operator-sdk_bundle_validate +[doc-olm-generate]:/docs/olm-integration/generation +[cli-olm-install]:/docs/cli/operator-sdk_olm_install +[cli-olm-status]:/docs/cli/operator-sdk_olm_status +[cli-olm-uninstall]:/docs/cli/operator-sdk_olm_uninstall +[cli-gen-bundle]:/docs/cli/operator-sdk_generate_bundle +[cli-gen-packagemanifests]:/docs/cli/operator-sdk_generate_packagemanifests +[cli-gen-kustomize-manifests]:/docs/cli/operator-sdk_generate_kustomize_manifests +[cli-bundle-validate]:/docs/cli/operator-sdk_bundle_validate [doc-testing-deployment]:/docs/olm-integration/testing-deployment diff --git a/website/content/en/docs/olm-integration/generating-a-csv.md b/website/content/en/docs/olm-integration/generation.md similarity index 98% rename from website/content/en/docs/olm-integration/generating-a-csv.md rename to website/content/en/docs/olm-integration/generation.md index 54a6fbfb9b..64d5fa2587 100644 --- a/website/content/en/docs/olm-integration/generating-a-csv.md +++ b/website/content/en/docs/olm-integration/generation.md @@ -241,9 +241,9 @@ being managed, each with a `name` and `url`. [olm]:https://github.com/operator-framework/operator-lifecycle-manager [doc-csv]:https://github.com/operator-framework/operator-lifecycle-manager/blob/0.15.1/doc/design/building-your-csv.md [cli-overview]:/docs/olm-integration/cli-overview -[cli-gen-kustomize-manifests]:/docs/cli/golang/operator-sdk_generate_kustomize_manifests -[cli-gen-bundle]:/docs/cli/golang/operator-sdk_generate_bundle -[cli-gen-packagemanifests]:/docs/cli/golang/operator-sdk_generate_packagemanifests +[cli-gen-kustomize-manifests]:/docs/cli/operator-sdk_generate_kustomize_manifests +[cli-gen-bundle]:/docs/cli/operator-sdk_generate_bundle +[cli-gen-packagemanifests]:/docs/cli/operator-sdk_generate_packagemanifests [bundle]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md [bundle-metadata]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md#bundle-annotations [package-manifests]:https://github.com/operator-framework/operator-registry/tree/v1.5.3#manifest-format diff --git a/website/content/en/docs/olm-integration/quickstart-bundle.md b/website/content/en/docs/olm-integration/quickstart-bundle.md index 5f293f6105..21ae2af50d 100644 --- a/website/content/en/docs/olm-integration/quickstart-bundle.md +++ b/website/content/en/docs/olm-integration/quickstart-bundle.md @@ -147,9 +147,9 @@ about your cataloged Operator. [bundle]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md [bundle-metadata]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md#bundle-annotations [bundle-dockerfile]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md#bundle-dockerfile -[cli-olm]:/docs/cli/golang/operator-sdk_olm +[cli-olm]:/docs/cli/operator-sdk_olm [doc-cli-overview]:/docs/olm-integration/cli-overview -[doc-olm-generate]:/docs/olm-integration/generating-a-csv +[doc-olm-generate]:/docs/olm-integration/generation [opm]:https://github.com/operator-framework/operator-registry/blob/master/docs/design/opm-tooling.md [index-image]:https://github.com/operator-framework/operator-registry/blob/master/docs/design/opm-tooling.md#index [doc-index-build]:https://github.com/operator-framework/operator-registry#building-an-index-of-operators-using-opm diff --git a/website/content/en/docs/olm-integration/quickstart-package-manifests.md b/website/content/en/docs/olm-integration/quickstart-package-manifests.md index 7de9069610..da5cc08ab5 100644 --- a/website/content/en/docs/olm-integration/quickstart-package-manifests.md +++ b/website/content/en/docs/olm-integration/quickstart-package-manifests.md @@ -85,7 +85,7 @@ INFO[0001] Successfully uninstalled "memcached-operator.v0.0.1" on OLM version " [quickstart-bundle]:/docs/olm-integration/quickstart-bundle [operator-registry]:https://github.com/operator-framework/operator-registry -[cli-run-packagemanifests]:/docs/cli/golang/operator-sdk_run_packagemanifests -[cli-cleanup-packagemanifests]:/docs/cli/golang/operator-sdk_cleanup_packagemanifests -[doc-olm-generate]:/docs/olm-integration/generating-a-csv#overview +[cli-run-packagemanifests]:/docs/cli/operator-sdk_run_packagemanifests +[cli-cleanup-packagemanifests]:/docs/cli/operator-sdk_cleanup_packagemanifests +[doc-olm-generate]:/docs/olm-integration/generation#overview [doc-testing-deployment]:/docs/olm-integration/testing-deployment diff --git a/website/content/en/docs/olm-integration/testing-deployment.md b/website/content/en/docs/olm-integration/testing-deployment.md index 52f52056b4..010cefb524 100644 --- a/website/content/en/docs/olm-integration/testing-deployment.md +++ b/website/content/en/docs/olm-integration/testing-deployment.md @@ -65,5 +65,5 @@ hence its intended purpose being testing only. [doc-cli-overview]:/docs/olm-integration/cli-overview [package-manifests]:https://github.com/operator-framework/operator-registry/tree/v1.5.3#manifest-format [csv-install-modes]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#operator-metadata -[cli-olm-install]:/docs/cli/golang/operator-sdk_olm_install -[cli-olm-status]:/docs/cli/golang/operator-sdk_olm_status +[cli-olm-install]:/docs/cli/operator-sdk_olm_install +[cli-olm-status]:/docs/cli/operator-sdk_olm_status