Skip to content

Commit 75bfde9

Browse files
authored
Merge pull request #57337 from subhtk/OCPBUG5193
OCPBUGS#5193: Added descriptive commands in opm CLI reference section.
2 parents 6abdb1c + bc131a0 commit 75bfde9

File tree

3 files changed

+97
-4
lines changed

3 files changed

+97
-4
lines changed

cli_reference/opm/cli-opm-ref.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,12 @@ $ opm <command> [<subcommand>] [<argument>] [<flags>]
1919
|===
2020
|Flag |Description
2121

22-
|`--skip-tls`
22+
|`-skip-tls-verify`
2323
|Skip TLS certificate verification for container image registries while pulling bundles or indexes.
2424

25+
|`--use-http`
26+
|When you pull bundles, use plain HTTP for container image registries.
27+
2528
|===
2629

2730
:FeatureName: The SQLite-based catalog format, including the related CLI commands,
@@ -37,6 +40,7 @@ include::modules/deprecated-feature.adoc[]
3740

3841
include::modules/opm-cli-ref-migrate.adoc[leveloffset=+1]
3942
include::modules/opm-cli-ref-index.adoc[leveloffset=+1]
43+
include::modules/opm-cli-ref-generate.adoc[leveloffset=+1]
4044

4145
[role="_additional-resources"]
4246
.Additional resources

modules/opm-cli-ref-generate.adoc

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
//Module included in the following assemblies:
2+
//
3+
//*cli_reference/opm/cli-opm-ref.adoc
4+
5+
[id="opm-cli-ref-generate_{Context}"]
6+
= generate
7+
8+
Generate various artifacts for declarative config indexes.
9+
10+
.Command syntax
11+
[source,terminal]
12+
----
13+
$ opm generate [command]
14+
----
15+
16+
.`generate` flags
17+
[options="header",cols="1,3"]
18+
|===
19+
|Flags |Description
20+
21+
|`-h`, `--help`
22+
|Help for generate.
23+
24+
|===
25+
26+
.Command syntax
27+
[source,terminal]
28+
----
29+
$ opm generate <subcommand> [<flags>]
30+
----
31+
32+
.`generate` subcommands
33+
[options="header",cols="1,3"]
34+
|===
35+
|Subcommand |Description
36+
37+
|`dockerfile`
38+
|Generate a Dockerfile for a declarative config index.
39+
40+
|===
41+
42+
[id="opm-cli-ref-generate-dockerfile_{context}"]
43+
== dockerfile
44+
45+
Generate a Dockerfile for a declarative config index.
46+
47+
[IMPORTANT]
48+
====
49+
This command creates a Dockerfile in the same directory as the <dcRootDir> (named <dcDirName>.Dockerfile) that is used to build the index. If a Dockerfile with the same name already exists, this command fails.
50+
51+
When specifying extra labels, if duplicate keys exist, only the last value of each duplicate key gets added to the generated Dockerfile.
52+
====
53+
54+
.Command syntax
55+
[source,terminal]
56+
----
57+
$ opm generate dockerfile <dcRootDir> [flags]
58+
----
59+
60+
.`generate dockerfile` flags
61+
[options="header",cols="1,3"]
62+
|===
63+
|Flag |Description
64+
65+
|`-i,` `--binary-image` (string)
66+
|Image in which to build catalog. The default value is `quay.io/operator-framework/opm:latest`.
67+
68+
|`-l`, `--extra-labels` (string)
69+
|Extra labels to include in the generated Dockerfile. Labels have the form `key=value`.
70+
71+
|`-h`, `--help`
72+
|Help for Dockerfile.
73+
74+
|===

modules/opm-cli-ref-serve.adoc

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,28 @@ $ opm serve <source_path> [<flags>]
2323
|===
2424
|Flag |Description
2525

26+
|`--cache-dir` (string)
27+
|If this flag is set, it syncs and persists the server cache directory.
28+
29+
|`--cache-enforce-integrity`
30+
|Exits with an error if the cache is not present or is invalidated. The default value is `true` when the `--cache-dir` flag is set and the `--cache-only` flag is `false`. Otherwise, the default is `false`.
31+
32+
|`--cache-only`
33+
|Syncs the serve cache and exits without serving.
34+
2635
|`--debug`
27-
|Enable debug logging.
36+
|Enables debug logging.
37+
38+
|`h`, `--help`
39+
|Help for serve.
2840

2941
|`-p`, `--port` (string)
30-
|Port number to serve on. Default: `50051`.
42+
|The port number for the service. The default value is `50051`.
43+
44+
|`--pprof-addr` (string)
45+
|The address of the startup profiling endpoint. The format is `Addr:Port`.
3146

3247
|`-t`, `--termination-log` (string)
33-
|Path to a container termination log file. Default: `/dev/termination-log`.
48+
|The path to a container termination log file. The default value is `/dev/termination-log`.
3449

3550
|===

0 commit comments

Comments
 (0)