Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update long description indentation for alpha #789

Merged
merged 1 commit into from
Sep 23, 2021
Merged

Update long description indentation for alpha #789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions cmd/opm/alpha/bundle/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,23 @@ func newBundleBuildCmd() *cobra.Command {
Use: "build",
Short: "Build operator bundle image",
Long: `The "opm alpha bundle build" command will generate operator
bundle metadata if needed and build bundle image with operator manifest
and metadata for a specific version.
bundle metadata if needed and build bundle image with operator manifest
and metadata for a specific version.

For example: The command will generate annotations.yaml metadata plus
Dockerfile for bundle image and then build a container image from
provided operator bundle manifests generated metadata
e.g. "quay.io/example/operator:v0.0.1".
For example: The command will generate annotations.yaml metadata plus
Dockerfile for bundle image and then build a container image from
provided operator bundle manifests generated metadata
e.g. "quay.io/example/operator:v0.0.1".

After the build process is completed, a container image would be built
locally in docker and available to push to a container registry.
After the build process is completed, a container image would be built
locally in docker and available to push to a container registry.

$ opm alpha bundle build --directory /test/0.1.0/ --tag quay.io/example/operator:v0.1.0 \
--package test-operator --channels stable,beta --default stable --overwrite
$ opm alpha bundle build --directory /test/0.1.0/ --tag quay.io/example/operator:v0.1.0 \
--package test-operator --channels stable,beta --default stable --overwrite

Note:
* Bundle image is not runnable.
* All manifests yaml must be in the same directory.
`,
Note:
* Bundle image is not runnable.
* All manifests yaml must be in the same directory. `,
RunE: buildFunc,
}

Expand Down
11 changes: 5 additions & 6 deletions cmd/opm/alpha/bundle/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ func newBundleGenerateCmd() *cobra.Command {
Use: "generate",
Short: "Generate operator bundle metadata and Dockerfile",
Long: `The "opm alpha bundle generate" command will generate operator
bundle metadata if needed and a Dockerfile to build Operator bundle image.
bundle metadata if needed and a Dockerfile to build Operator bundle image.

$ opm alpha bundle generate --directory /test/0.1.0/ --package test-operator \
--channels stable,beta --default stable
$ opm alpha bundle generate --directory /test/0.1.0/ --package test-operator \
--channels stable,beta --default stable

Note:
* All manifests yaml must be in the same directory.
`,
Note:
* All manifests yaml must be in the same directory.`,
RunE: generateFunc,
}

Expand Down