Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 95291b7

Browse files
committedMar 25, 2020
docs(opm): add self-contained container-tools section
1 parent 34491cc commit 95291b7

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed
 

‎docs/design/opm-tooling.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,30 @@ which can be pushed to appregistry.
128128

129129
**Note**: the appregistry format is being deprecated in favor of the new index image and image bundle format.
130130

131-
### Container Tooling
131+
### External Container Tooling
132132

133-
Of note, many of these commands require some form of shelling to common container tooling (in the general case at least to pull the bundle image and extract the contents to update the registry). By default, the container tool that `opm` shells to is [podman](https://podman.io/). However, we also support overriding this via the `--container-tool` flag in all of these commands:
133+
Of note, many of these commands require some form of shelling to common container tooling. By default, the container tool that `opm` shells to is [podman](https://podman.io/). However, we also support overriding this via the `--container-tool`.
134134

135-
`opm registry add -b "quay.io/operator-framework/operator-bundle-prometheus:0.14.0" -d "test-registry.db" --container-tool docker`
135+
_Ex._
136136

137-
This will run `opm registry add` via the docker runtime.
137+
`opm index add --bundles quay.io/operator-framework/operator-bundle-prometheus:0.14.0 --tag quay.io/operator-framework/monitoring-index:1.0.0 --container-tool docker`
138+
139+
These commands require shelling to an external tool:
140+
141+
- `opm index add`
142+
- `opm index rm`
143+
- `opm index export`
144+
145+
### Self-Contained Container Tooling
146+
147+
There are a few commands that use self-contained container tooling. These commands do not require shelling to an external tool:
148+
149+
- `opm registry add`
150+
151+
#### Configuration
152+
153+
By default, the self-contained tooling uses the standard [Docker config](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) in the `~/.docker` directory. This can be changed by setting the `DOCKER_CONFIG` environment variable.
154+
155+
#### Authentication
156+
157+
Authentication options [can be added](https://docs.docker.com/engine/reference/commandline/login/#credentials-store) to the standard Docker config. The self-contained tooling should also be able to use the system credential store out-of-the-box.

0 commit comments

Comments
 (0)
Please sign in to comment.