Skip to content

Commit 068022d

Browse files
author
Ish Shah
committed
initial draft of generated docs
1 parent a9a2168 commit 068022d

31 files changed

+900
-0
lines changed

‎doc/cli/operator-sdk.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## operator-sdk
2+
3+
An SDK for building operators with ease
4+
5+
### Synopsis
6+
7+
An SDK for building operators with ease
8+
9+
### Options
10+
11+
```
12+
-h, --help help for operator-sdk
13+
```
14+
15+
### SEE ALSO
16+
17+
* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project
18+
* [operator-sdk alpha](operator-sdk_alpha.md) - Run an alpha subcommand
19+
* [operator-sdk build](operator-sdk_build.md) - Compiles code and builds artifacts
20+
* [operator-sdk completion](operator-sdk_completion.md) - Generators for shell completions
21+
* [operator-sdk generate](operator-sdk_generate.md) - Invokes specific generator
22+
* [operator-sdk migrate](operator-sdk_migrate.md) - Adds source code to an operator
23+
* [operator-sdk new](operator-sdk_new.md) - Creates a new operator application
24+
* [operator-sdk olm-catalog](operator-sdk_olm-catalog.md) - Invokes a olm-catalog command
25+
* [operator-sdk print-deps](operator-sdk_print-deps.md) - Print Golang packages and versions required to run the operator
26+
* [operator-sdk run](operator-sdk_run.md) - Runs a generic operator
27+
* [operator-sdk scorecard](operator-sdk_scorecard.md) - Run scorecard tests
28+
* [operator-sdk test](operator-sdk_test.md) - Tests the operator
29+
* [operator-sdk up](operator-sdk_up.md) - Launches the operator
30+
* [operator-sdk version](operator-sdk_version.md) - Prints the version of operator-sdk
31+
32+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_add.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## operator-sdk add
2+
3+
Adds a controller or resource to the project
4+
5+
### Synopsis
6+
7+
Adds a controller or resource to the project
8+
9+
### Options
10+
11+
```
12+
-h, --help help for add
13+
```
14+
15+
### SEE ALSO
16+
17+
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
18+
* [operator-sdk add api](operator-sdk_add_api.md) - Adds a new api definition under pkg/apis
19+
* [operator-sdk add controller](operator-sdk_add_controller.md) - Adds a new controller pkg
20+
* [operator-sdk add crd](operator-sdk_add_crd.md) - Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files
21+
22+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_add_api.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## operator-sdk add api
2+
3+
Adds a new api definition under pkg/apis
4+
5+
### Synopsis
6+
7+
operator-sdk add api --kind=<kind> --api-version=<group/version> creates the
8+
api definition for a new custom resource under pkg/apis. This command must be
9+
run from the project root directory. If the api already exists at
10+
pkg/apis/<group>/<version> then the command will not overwrite and return an
11+
error.
12+
13+
By default, this command runs Kubernetes deepcopy and OpenAPI V3 generators on
14+
tagged types in all paths under pkg/apis. Go code is generated under
15+
pkg/apis/<group>/<version>/zz_generated.{deepcopy,openapi}.go. CRD's are
16+
generated, or updated if they exist for a particular group + version + kind,
17+
under deploy/crds/<full group>_<resource>_crd.yaml; OpenAPI V3 validation YAML
18+
is generated as a 'validation' object. Generation can be disabled with the
19+
--skip-generation flag.
20+
21+
Example:
22+
$ operator-sdk add api --api-version=app.example.com/v1alpha1 --kind=AppService
23+
$ tree pkg/apis
24+
pkg/apis/
25+
├── addtoscheme_app_appservice.go
26+
├── apis.go
27+
└── app
28+
└── v1alpha1
29+
├── doc.go
30+
├── register.go
31+
├── appservice_types.go
32+
├── zz_generated.deepcopy.go
33+
├── zz_generated.openapi.go
34+
$ tree deploy/crds
35+
├── deploy/crds/app.example.com_v1alpha1_appservice_cr.yaml
36+
├── deploy/crds/app.example.com_appservices_crd.yaml
37+
38+
39+
```
40+
operator-sdk add api [flags]
41+
```
42+
43+
### Options
44+
45+
```
46+
--api-version string Kubernetes APIVersion that has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
47+
-h, --help help for api
48+
--kind string Kubernetes resource Kind name. (e.g AppService)
49+
--skip-generation Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs
50+
```
51+
52+
### SEE ALSO
53+
54+
* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project
55+
56+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_add_controller.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## operator-sdk add controller
2+
3+
Adds a new controller pkg
4+
5+
### Synopsis
6+
7+
operator-sdk add controller --kind=<kind> --api-version=<group/version> creates a new
8+
controller pkg under pkg/controller/<kind> that, by default, reconciles on a custom resource for the specified apiversion and kind.
9+
The controller will expect to use the custom resource type that should already be defined under pkg/apis/<group>/<version>
10+
via the "operator-sdk add api --kind=<kind> --api-version=<group/version>" command.
11+
This command must be run from the project root directory.
12+
If the controller pkg for that Kind already exists at pkg/controller/<kind> then the command will not overwrite and return an error.
13+
14+
Example:
15+
$ operator-sdk add controller --api-version=app.example.com/v1alpha1 --kind=AppService
16+
$ tree pkg/controller
17+
pkg/controller/
18+
├── add_appservice.go
19+
├── appservice
20+
│   └── appservice_controller.go
21+
└── controller.go
22+
23+
24+
25+
```
26+
operator-sdk add controller [flags]
27+
```
28+
29+
### Options
30+
31+
```
32+
--api-version string Kubernetes APIVersion that has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
33+
--custom-api-import string External Kubernetes resource import path of the form "host.com/repo/path[=import_identifier]". import_identifier is optional
34+
-h, --help help for controller
35+
--kind string Kubernetes resource Kind name. (e.g AppService)
36+
```
37+
38+
### SEE ALSO
39+
40+
* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project
41+
42+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_add_crd.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## operator-sdk add crd
2+
3+
Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files
4+
5+
### Synopsis
6+
7+
The operator-sdk add crd command will create a Custom Resource Definition (CRD) and the Custom Resource (CR) files for the specified api-version and kind.
8+
9+
Generated CRD filename: <project-name>/deploy/crds/<full group>_<resource>_crd.yaml
10+
Generated CR filename: <project-name>/deploy/crds/<full group>_<version>_<kind>_cr.yaml
11+
12+
<project-name>/deploy path must already exist
13+
--api-version and --kind are required flags to generate the new operator application.
14+
15+
16+
```
17+
operator-sdk add crd [flags]
18+
```
19+
20+
### Options
21+
22+
```
23+
--api-version string Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
24+
-h, --help help for crd
25+
--kind string Kubernetes CustomResourceDefintion kind. (e.g AppService)
26+
```
27+
28+
### SEE ALSO
29+
30+
* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project
31+
32+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_alpha.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## operator-sdk alpha
2+
3+
Run an alpha subcommand
4+
5+
### Synopsis
6+
7+
Run an alpha subcommand
8+
9+
### Options
10+
11+
```
12+
-h, --help help for alpha
13+
```
14+
15+
### SEE ALSO
16+
17+
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
18+
* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster
19+
20+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_alpha_olm.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## operator-sdk alpha olm
2+
3+
Manage the Operator Lifecycle Manager installation in your cluster
4+
5+
### Synopsis
6+
7+
Manage the Operator Lifecycle Manager installation in your cluster
8+
9+
### Options
10+
11+
```
12+
-h, --help help for olm
13+
```
14+
15+
### SEE ALSO
16+
17+
* [operator-sdk alpha](operator-sdk_alpha.md) - Run an alpha subcommand
18+
* [operator-sdk alpha olm install](operator-sdk_alpha_olm_install.md) - Install Operator Lifecycle Manager in your cluster
19+
* [operator-sdk alpha olm status](operator-sdk_alpha_olm_status.md) - Get the status of the Operator Lifecycle Manager installation in your cluster
20+
* [operator-sdk alpha olm uninstall](operator-sdk_alpha_olm_uninstall.md) - Uninstall Operator Lifecycle Manager from your cluster
21+
22+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_alpha_olm_install.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## operator-sdk alpha olm install
2+
3+
Install Operator Lifecycle Manager in your cluster
4+
5+
### Synopsis
6+
7+
Install Operator Lifecycle Manager in your cluster
8+
9+
```
10+
operator-sdk alpha olm install [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for install
17+
--timeout duration time to wait for the command to complete before failing (default 2m0s)
18+
--version string version of OLM resources to install (default "latest")
19+
```
20+
21+
### SEE ALSO
22+
23+
* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster
24+
25+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_alpha_olm_status.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## operator-sdk alpha olm status
2+
3+
Get the status of the Operator Lifecycle Manager installation in your cluster
4+
5+
### Synopsis
6+
7+
Get the status of the Operator Lifecycle Manager installation in your cluster
8+
9+
```
10+
operator-sdk alpha olm status [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for status
17+
--timeout duration time to wait for the command to complete before failing (default 2m0s)
18+
```
19+
20+
### SEE ALSO
21+
22+
* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster
23+
24+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_alpha_olm_uninstall.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## operator-sdk alpha olm uninstall
2+
3+
Uninstall Operator Lifecycle Manager from your cluster
4+
5+
### Synopsis
6+
7+
Uninstall Operator Lifecycle Manager from your cluster
8+
9+
```
10+
operator-sdk alpha olm uninstall [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for uninstall
17+
--timeout duration time to wait for the command to complete before failing (default 2m0s)
18+
```
19+
20+
### SEE ALSO
21+
22+
* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster
23+
24+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_build.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## operator-sdk build
2+
3+
Compiles code and builds artifacts
4+
5+
### Synopsis
6+
7+
The operator-sdk build command compiles the Operator code into an executable binary
8+
and generates the Dockerfile manifest.
9+
10+
<image> is the container image to be built, e.g. "quay.io/example/operator:v0.0.1".
11+
This image will be automatically set in the deployment manifests.
12+
13+
After build completes, the image would be built locally in docker. Then it needs to
14+
be pushed to remote registry.
15+
For example:
16+
$ operator-sdk build quay.io/example/operator:v0.0.1
17+
$ docker push quay.io/example/operator:v0.0.1
18+
19+
20+
```
21+
operator-sdk build <image> [flags]
22+
```
23+
24+
### Options
25+
26+
```
27+
--go-build-args string Extra Go build arguments as one string such as "-ldflags -X=main.xyz=abc"
28+
-h, --help help for build
29+
--image-build-args string Extra image build arguments as one string such as "--build-arg https_proxy=$https_proxy"
30+
--image-builder string Tool to build OCI images. One of: [docker, podman, buildah] (default "docker")
31+
```
32+
33+
### SEE ALSO
34+
35+
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
36+
37+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_completion.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## operator-sdk completion
2+
3+
Generators for shell completions
4+
5+
### Synopsis
6+
7+
Generators for shell completions
8+
9+
### Options
10+
11+
```
12+
-h, --help help for completion
13+
```
14+
15+
### SEE ALSO
16+
17+
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
18+
* [operator-sdk completion bash](operator-sdk_completion_bash.md) - Generate bash completions
19+
* [operator-sdk completion zsh](operator-sdk_completion_zsh.md) - Generate zsh completions
20+
21+
###### Auto generated by spf13/cobra on 23-Oct-2019

‎doc/cli/operator-sdk_completion_bash.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## operator-sdk completion bash
2+
3+
Generate bash completions
4+
5+
### Synopsis
6+
7+
Generate bash completions
8+
9+
```
10+
operator-sdk completion bash [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for bash
17+
```
18+
19+
### SEE ALSO
20+
21+
* [operator-sdk completion](operator-sdk_completion.md) - Generators for shell completions
22+
23+
###### Auto generated by spf13/cobra on 23-Oct-2019

0 commit comments

Comments
 (0)