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

doc: cover the inline-specified variants of arguments to oci_image #705

Merged
merged 2 commits into from
Oct 28, 2024
Merged

doc: cover the inline-specified variants of arguments to oci_image #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f959202
doc: cover the inline-specified variants of arguments to oci_image
plobsing Sep 28, 2024
f5ef3fd
Regenerate docs markdown
plobsing Sep 28, 2024
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
14 changes: 7 additions & 7 deletions docs/image.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 14 additions & 7 deletions oci/defs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,20 @@ def oci_image(name, labels = None, annotations = None, env = None, cmd = None, e

Args:
name: name of resulting oci_image_rule
labels: Labels for the image config. See documentation above.
annotations: Annotations for the image config. See documentation above.
env: Environment variables provisioned by default to the running container. See documentation above.
cmd: Command & argument configured by default in the running container. See documentation above.
entrypoint: Entrypoint configured by default in the running container. See documentation above.
exposed_ports: Exposed ports in the running container. See documentation above.
volumes: Volumes for the container. See documentation above.
labels: Labels for the image config.
May either be specified as a file, as with the documentation above, or a dict of strings to specify values inline.
annotations: Annotations for the image config.
May either be specified as a file, as with the documentation above, or a dict of strings to specify values inline.
env: Environment variables provisioned by default to the running container.
May either be specified as a file, as with the documentation above, or a dict of strings to specify values inline.
cmd: Command & argument configured by default in the running container.
May either be specified as a file, as with the documentation above. or a list of strings to specify values inline.
entrypoint: Entrypoint configured by default in the running container.
May either be specified as a file, as with the documentation above. or a list of strings to specify values inline.
exposed_ports: Exposed ports in the running container.
May either be specified as a file, as with the documentation above. or a list of strings to specify values inline.
volumes: Volumes for the container.
May either be specified as a file, as with the documentation above. or a list of strings to specify values inline.
**kwargs: other named arguments to [oci_image_rule](#oci_image_rule) and
[common rule attributes](https://bazel.build/reference/be/common-definitions#common-attributes).
"""
Expand Down
Loading