package infra.dev_container.muk
Get desktop application:
View/edit binary Protocol Buffers messages
message
muk.proto:63Used in:
oneof action
Actions are steps that are translated into Dockerfile line(s) (likely RUN steps). When choosing whether to implement a RUN as a `command` or as a new custom step added in this oneof below, consider that we don't need to add extra overhead for different types of commands, but it is useful in particular scenarios: 1. When the step is tough to get right: `apt install` of packages is an example - normally we do `apt install foo` on the commandline, but the best way in Dockerfiles is something like: * run apt with particular noninteractive environment vars * run apt update * add -y switch to apt install * clean up apt temp data when done ...which adds noise to each `apt install` line. In these cases, intent is best kept with a custom Action, letting the tool do the generation of the command. 2. When there are multiple ways to do it - adding apt repos is commonly done via `curl`ing some GPG key followed by writing to an apt repo list file - but where to store the key, curl flags, what list file (appending to the general file vs a dedicated file) varies. Having a custom action can ensure that there is one "right" way to enforce conventions. 3. Abstraction across multiple OS's (not yet seen with existing actions)
command = 1
Run an arbitrary command
apt_install = 2
Install packages via apt. `apt update` is always run before this step, and cleanup of the apt cache is always performed afterwards.
dpkg_add_arch = 3
Add an architecture to Debian/Ubuntu-based package managers TODO(bbhuynh): Consider removing dpkg_add_arch; it offers litte value over the verbatim command
apt_add_repo = 4
Add an apt repo to a Debian/Ubuntu-based image
apt_add_ppa = 5
Add an apt PPA to a Debian/Ubuntu-based image TODO(bbhuynh): Consider removing apt_add_ppa; it offers litte value over the verbatim command
add_yum_repo = 6
Add repos for centos-based images
yum_install = 7
Always perform a 'yum update' before installing packages and 'yum clean all' afterwards
env = 8
untar = 9
message
muk.proto:155Used in:
string name = 1
Unique name of the centos-based repository
string base_url = 2
URL to download the package
optional string gpgkey = 3
Tells yum whether to use this repo or not URL to the GPG security key
message
muk.proto:196Used in:
string name = 1
Name of the PPA, with `ppa:` prefix omitted. Example: `git-core/ppa`
message
muk.proto:168Add an apt repository. These are present in sources.list files in the format: deb [option=value option2=value1,value2] binary_url distribution component_1 component_2
Used in:
string name = 1
Name of the repository to add. This name should be unique across all apt repos added.
string binary_url = 2
URL for binary package downloads.
string distribution = 3
Distribution that apt packages should be fetched for. This corresponds to a particular field of a sources.list entry (see above).
repeated string components = 4
Optional list of components to fetch packages for. This corresponds to a particular set of fields of a sources.list entry (see above).
repeated repo_options = 5
Optional list of options for this repository. This is typically used to specify e.g. architecture, and if present is located in square brackets in an Ubuntu sources.list entry. Signing key options will get added by the tool, and should not be added here.
optional signing_key = 6
If set, will download and install an apt signing key specific to this repository.
message
muk.proto:143Used in:
repeated string packages = 1
Packages to install via apt
message
muk.proto:201Used in:
string name = 1
Key of the repository option (example: `arch`)
repeated string values = 2
Values for the option (example: `amd64`)
message
muk.proto:209Used in:
string name = 1
Name of the apt key. Must be unique across all apt keys.
string url = 2
URL from which the key should be fetched.
message
muk.proto:49Used in:
string filename = 1
Name of the file in the container staging directory. Example: 'foo.txt' will be available for commands as `/astore/foo.txt`.
string astore_path = 2
Path to the file in astore. This is not enforced, and is here to aid with documentation only.
string uid = 3
UID of the file in astore.
message
muk.proto:124Used in:
string command = 1
Command to run, as if put in a `RUN` directive in a Dockerfile
enum Distro
muk.proto:43Used in:
UBUNTU = 0
CENTOS = 1
ROCKY = 3
message
muk.proto:217Used in:
string architecture = 1
Architecture to add (e.g. "i386")
message
muk.proto:136Used in:
string env = 1
ENV to set
string value = 2
Value to set
message
muk.proto:5string repository = 1
Repository for which the newly-built image should be tagged. The tag suffix is added via the command-line, not in this field. Example: gcr.io/devops-284019/my/image
string base_image = 2
Image on which this build is based. This should always be a full URL (so e.g. docker.io/library/ubuntu:tag instead of ubuntu:tag)
repeated astore_files = 3
Files downloaded and made available at build-time inside the `/astore` directory. These files must be used by Actions below; `/astore` is removed at the end of the image build.
repeated actions = 4
Build actions for this image, performed in-order.
Distro distro = 5
Different distros use different tools to manage packages:
optional user = 6
User UID and GID
message
muk.proto:129Used in:
string sourcepath = 1
Untar a file under this directory
string sourcefile = 2
The name of the file to untar
message
muk.proto:33Used in:
int32 uid = 1
User ID to run as in the container during build-time. The default value is 0 which is the root user.
int32 gid = 2
Group ID to run as in the container during build-time The default value is 0 which is the root group.
message
muk.proto:148Used in:
repeated string packages = 1
Packages to install via yum
repeated string rpms = 2
'yum localinstall' a list of downloaded *.rpm