BuildahBuildOptions.Generated.cs

// <auto-generated>
// This file was generated by ModularPipelines.OptionsGenerator.
// Do not edit this file manually.
// </auto-generated>

#nullable enable

using System.CodeDom.Compiler;
using System.Diagnostics.CodeAnalysis;
using ModularPipelines.Attributes;
using ModularPipelines.Buildah.Options;

namespace ModularPipelines.Buildah.Options;

/// <summary>
/// Builds an OCI image using instructions in one or more Containerfiles.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
[ExcludeFromCodeCoverage]
[CliSubCommand("build")]
public record BuildahBuildOptions : BuildahOptions
{
    /// <summary>
    /// add a custom host-to-IP mapping (host:ip) (default [])
    /// </summary>
    [CliOption("--add-host", Format = OptionFormat.EqualsSeparated)]
    public string? AddHost { get; set; }

    /// <summary>
    /// attempt to build for all base image platforms
    /// </summary>
    [CliFlag("--all-platforms")]
    public bool? AllPlatforms { get; set; }

    /// <summary>
    /// set metadata for an image (default [])
    /// </summary>
    [CliOption("--annotation", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Annotation { get; set; }

    /// <summary>
    /// set the ARCH of the image to the provided value instead of the architecture of the host (default "amd64")
    /// </summary>
    [CliOption("--arch", Format = OptionFormat.EqualsSeparated)]
    public string? Arch { get; set; }

    /// <summary>
    /// path of the authentication file.
    /// </summary>
    [CliOption("--authfile", Format = OptionFormat.EqualsSeparated)]
    public string? Authfile { get; set; }

    /// <summary>
    /// argument=value to supply to the builder
    /// </summary>
    [CliOption("--build-arg", Format = OptionFormat.EqualsSeparated)]
    public string? BuildArg { get; set; }

    /// <summary>
    /// argfile.conf containing lines of argument=value to supply to the builder
    /// </summary>
    [CliOption("--build-arg-file", Format = OptionFormat.EqualsSeparated)]
    public string? BuildArgFile { get; set; }

    /// <summary>
    /// argument=value to supply additional build context to the builder
    /// </summary>
    [CliOption("--build-context", Format = OptionFormat.EqualsSeparated)]
    public string? BuildContext { get; set; }

    /// <summary>
    /// remote repository list to utilise as potential cache source.
    /// </summary>
    [CliOption("--cache-from", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? CacheFrom { get; set; }

    /// <summary>
    /// remote repository list to utilise as potential cache destination.
    /// </summary>
    [CliOption("--cache-to", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? CacheTo { get; set; }

    /// <summary>
    /// only consider cache images under specified duration.
    /// </summary>
    [CliOption("--cache-ttl", Format = OptionFormat.EqualsSeparated)]
    public string? CacheTtl { get; set; }

    /// <summary>
    /// add the specified capability when running (default [])
    /// </summary>
    [CliOption("--cap-add", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? CapAdd { get; set; }

    /// <summary>
    /// drop the specified capability when running (default [])
    /// </summary>
    [CliOption("--cap-drop", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? CapDrop { get; set; }

    /// <summary>
    /// use certificates at the specified path to access the registry
    /// </summary>
    [CliOption("--cert-dir", Format = OptionFormat.EqualsSeparated)]
    public string? CertDir { get; set; }

    /// <summary>
    /// optional parent cgroup for the container
    /// </summary>
    [CliOption("--cgroup-parent", Format = OptionFormat.EqualsSeparated)]
    public string? CgroupParent { get; set; }

    /// <summary>
    /// 'private', or 'host'
    /// </summary>
    [CliOption("--cgroupns", Format = OptionFormat.EqualsSeparated)]
    public string? Cgroupns { get; set; }

    /// <summary>
    /// this is a legacy option, which has no effect on the image
    /// </summary>
    [CliFlag("--compress")]
    public bool? Compress { get; set; }

    /// <summary>
    /// set additional flag to pass to C preprocessor (cpp)
    /// </summary>
    [CliOption("--cpp-flag", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? CppFlag { get; set; }

    /// <summary>
    /// limit the CPU CFS (Completely Fair Scheduler) period
    /// </summary>
    [CliOption("--cpu-period", Format = OptionFormat.EqualsSeparated)]
    public int? CpuPeriod { get; set; }

    /// <summary>
    /// limit the CPU CFS (Completely Fair Scheduler) quota
    /// </summary>
    [CliOption("--cpu-quota", Format = OptionFormat.EqualsSeparated)]
    public int? CpuQuota { get; set; }

    /// <summary>
    /// CPU shares (relative weight)
    /// </summary>
    [CliOption("--cpu-shares", ShortForm = "-c", Format = OptionFormat.EqualsSeparated)]
    public int? CpuShares { get; set; }

    /// <summary>
    /// CPUs in which to allow execution (0-3, 0,1)
    /// </summary>
    [CliOption("--cpuset-cpus", Format = OptionFormat.EqualsSeparated)]
    public string? CpusetCpus { get; set; }

    /// <summary>
    /// memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
    /// </summary>
    [CliOption("--cpuset-mems", Format = OptionFormat.EqualsSeparated)]
    public string? CpusetMems { get; set; }

    /// <summary>
    /// use [username[:password]] for accessing the registry
    /// </summary>
    [CliOption("--creds", Format = OptionFormat.EqualsSeparated)]
    public string? Creds { get; set; }

    /// <summary>
    /// confidential workload options
    /// </summary>
    [CliOption("--cw", Format = OptionFormat.EqualsSeparated)]
    public string? Cw { get; set; }

    /// <summary>
    /// key needed to decrypt the image
    /// </summary>
    [CliOption("--decryption-key", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? DecryptionKey { get; set; }

    /// <summary>
    /// additional devices to be used within containers (default [])
    /// </summary>
    [CliOption("--device", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Device { get; set; }

    /// <summary>
    /// don't compress layers by default (default true)
    /// </summary>
    [CliFlag("--disable-compression", ShortForm = "-D")]
    public bool? DisableCompression { get; set; }

    /// <summary>
    /// this is a Docker specific option and is a NOOP
    /// </summary>
    [CliFlag("--disable-content-trust")]
    public bool? DisableContentTrust { get; set; }

    /// <summary>
    /// set custom DNS servers or disable it completely by setting it to 'none', which prevents the automatic creation of /etc/resolv.conf.
    /// </summary>
    [CliOption("--dns", Format = OptionFormat.EqualsSeparated)]
    public string? Dns { get; set; }

    /// <summary>
    /// set custom DNS options
    /// </summary>
    [CliOption("--dns-option", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? DnsOption { get; set; }

    /// <summary>
    /// set custom DNS search domains
    /// </summary>
    [CliOption("--dns-search", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? DnsSearch { get; set; }

    /// <summary>
    /// set environment variable for the image
    /// </summary>
    [CliOption("--env", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Env { get; set; }

    /// <summary>
    /// always remove intermediate containers after a build, even if the build is unsuccessful.
    /// </summary>
    [CliFlag("--force-rm")]
    public bool? ForceRm { get; set; }

    /// <summary>
    /// format of the built image's manifest and metadata. Use BUILDAH_FORMAT environment variable to override. (default "oci")
    /// </summary>
    [CliOption("--format", Format = OptionFormat.EqualsSeparated)]
    public string? Format { get; set; }

    /// <summary>
    /// image name used to replace the value in the first FROM instruction in the Containerfile
    /// </summary>
    [CliOption("--from", Format = OptionFormat.EqualsSeparated)]
    public string? From { get; set; }

    /// <summary>
    /// add additional groups to the primary container process. 'keep-groups' allows container processes to use supplementary groups.
    /// </summary>
    [CliOption("--group-add", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? GroupAdd { get; set; }

    /// <summary>
    /// help for build
    /// </summary>
    [CliFlag("--help", ShortForm = "-h")]
    public bool? Help { get; set; }

    /// <summary>
    /// set the OCI hooks directory path (may be set multiple times)
    /// </summary>
    [CliOption("--hooks-dir", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? HooksDir { get; set; }

    /// <summary>
    /// pass through HTTP Proxy environment variables (default true)
    /// </summary>
    [CliFlag("--http-proxy")]
    public bool? HttpProxy { get; set; }

    /// <summary>
    /// add default identity label (default true)
    /// </summary>
    [CliFlag("--identity-label")]
    public bool? IdentityLabel { get; set; }

    /// <summary>
    /// path to an alternate .dockerignore file
    /// </summary>
    [CliOption("--ignorefile", Format = OptionFormat.EqualsSeparated)]
    public string? Ignorefile { get; set; }

    /// <summary>
    /// file to write the image ID to
    /// </summary>
    [CliOption("--iidfile", Format = OptionFormat.EqualsSeparated)]
    public string? Iidfile { get; set; }

    /// <summary>
    /// 'private', path of IPC namespace to join, or 'host'
    /// </summary>
    [CliOption("--ipc", Format = OptionFormat.EqualsSeparated)]
    public string? Ipc { get; set; }

    /// <summary>
    /// type of process isolation to use. Use BUILDAH_ISOLATION environment variable to override. (default "rootless")
    /// </summary>
    [CliOption("--isolation", Format = OptionFormat.EqualsSeparated)]
    public string? Isolation { get; set; }

    /// <summary>
    /// how many stages to run in parallel (default 1)
    /// </summary>
    [CliOption("--jobs", Format = OptionFormat.EqualsSeparated)]
    public int? Jobs { get; set; }

    /// <summary>
    /// set metadata for an image (default [])
    /// </summary>
    [CliOption("--label", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Label { get; set; }

    /// <summary>
    /// set metadata for an intermediate image (default [])
    /// </summary>
    [CliOption("--layer-label", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? LayerLabel { get; set; }

    /// <summary>
    /// use intermediate layers during build. Use BUILDAH_LAYERS environment variable to override.
    /// </summary>
    [CliFlag("--layers")]
    public bool? Layers { get; set; }

    /// <summary>
    /// log to file instead of stdout/stderr
    /// </summary>
    [CliOption("--logfile", Format = OptionFormat.EqualsSeparated)]
    public string? Logfile { get; set; }

    /// <summary>
    /// split logfile to different files for each platform
    /// </summary>
    [CliFlag("--logsplit")]
    public bool? Logsplit { get; set; }

    /// <summary>
    /// add the image to the specified manifest list. Creates manifest list if it does not exist
    /// </summary>
    [CliOption("--manifest", Format = OptionFormat.EqualsSeparated)]
    public string? Manifest { get; set; }

    /// <summary>
    /// memory limit (format: &lt;number&gt;[&lt;unit&gt;], where unit = b, k, m or g)
    /// </summary>
    [CliOption("--memory", ShortForm = "-m", Format = OptionFormat.EqualsSeparated)]
    public string? Memory { get; set; }

    /// <summary>
    /// swap limit equal to memory plus swap: '-1' to enable unlimited swap
    /// </summary>
    [CliOption("--memory-swap", Format = OptionFormat.EqualsSeparated)]
    public string? MemorySwap { get; set; }

    /// <summary>
    /// 'private', 'none', 'ns:path' of network namespace to join, or 'host'
    /// </summary>
    [CliOption("--network", Format = OptionFormat.EqualsSeparated)]
    public string? Network { get; set; }

    /// <summary>
    /// do not use existing cached images for the container build. Build from the start with a new set of cached layers.
    /// </summary>
    [CliFlag("--no-cache")]
    public bool? NoCache { get; set; }

    /// <summary>
    /// do not create new /etc/hostname file for RUN instructions, use the one from the base image.
    /// </summary>
    [CliFlag("--no-hostname")]
    public bool? NoHostname { get; set; }

    /// <summary>
    /// do not create new /etc/hosts file for RUN instructions, use the one from the base image.
    /// </summary>
    [CliFlag("--no-hosts")]
    public bool? NoHosts { get; set; }

    /// <summary>
    /// omit build history information from built image
    /// </summary>
    [CliFlag("--omit-history")]
    public bool? OmitHistory { get; set; }

    /// <summary>
    /// set the OS to the provided value instead of the current operating system of the host (default "linux")
    /// </summary>
    [CliOption("--os", Format = OptionFormat.EqualsSeparated)]
    public string? Os { get; set; }

    /// <summary>
    /// set required OS feature for the target image in addition to values from the base image
    /// </summary>
    [CliOption("--os-feature", Format = OptionFormat.EqualsSeparated)]
    public string? OsFeature { get; set; }

    /// <summary>
    /// set required OS version for the target image instead of the value from the base image
    /// </summary>
    [CliOption("--os-version", Format = OptionFormat.EqualsSeparated)]
    public string? OsVersion { get; set; }

    /// <summary>
    /// output destination (format: type=local,dest=path)
    /// </summary>
    [CliOption("--output", ShortForm = "-o", Format = OptionFormat.EqualsSeparated)]
    public string? Output { get; set; }

    /// <summary>
    /// private, path of PID namespace to join, or 'host'
    /// </summary>
    [CliOption("--pid", Format = OptionFormat.EqualsSeparated)]
    public string? Pid { get; set; }

    /// <summary>
    /// set the OS/ARCH[/VARIANT] of the image to the provided value instead of the current operating system and architecture of the host (for example "linux/arm") (default [linux/amd64])
    /// </summary>
    [CliOption("--platform", Format = OptionFormat.EqualsSeparated)]
    public string? Platform { get; set; }

    /// <summary>
    /// pull the image from the registry if newer or not present in store, if false, only pull the image if not present, if always, pull the image even if the named image is present in store, if never, only use the image present in store if available (default "true")
    /// </summary>
    [CliOption("--pull", Format = OptionFormat.EqualsSeparated)]
    public string? Pull { get; set; }

    /// <summary>
    /// refrain from announcing build instructions and image read/write progress
    /// </summary>
    [CliFlag("--quiet", ShortForm = "-q")]
    public bool? Quiet { get; set; }

    /// <summary>
    /// number of times to retry in case of failure when performing push/pull (default 3)
    /// </summary>
    [CliOption("--retry", Format = OptionFormat.EqualsSeparated)]
    public int? Retry { get; set; }

    /// <summary>
    /// delay between retries in case of push/pull failures (default "2s")
    /// </summary>
    [CliOption("--retry-delay", Format = OptionFormat.EqualsSeparated)]
    public string? RetryDelay { get; set; }

    /// <summary>
    /// remove intermediate containers after a successful build (default true)
    /// </summary>
    [CliFlag("--rm")]
    public bool? Rm { get; set; }

    /// <summary>
    /// path to an alternate runtime. Use BUILDAH_RUNTIME environment variable to override. (default "crun")
    /// </summary>
    [CliOption("--runtime", Format = OptionFormat.EqualsSeparated)]
    public string? Runtime { get; set; }

    /// <summary>
    /// add global flags for the container runtime
    /// </summary>
    [CliOption("--runtime-flag", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? RuntimeFlag { get; set; }

    /// <summary>
    /// secret file to expose to the build
    /// </summary>
    [SecretValue]
    [CliOption("--secret", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Secret { get; set; }

    /// <summary>
    /// security options (default [])
    /// </summary>
    [CliOption("--security-opt", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? SecurityOpt { get; set; }

    /// <summary>
    /// size of '/dev/shm'. The format is &lt;number&gt;&lt;unit&gt;. (default "65536k")
    /// </summary>
    [CliOption("--shm-size", Format = OptionFormat.EqualsSeparated)]
    public string? ShmSize { get; set; }

    /// <summary>
    /// sign the image using a GPG key with the specified FINGERPRINT
    /// </summary>
    [CliOption("--sign-by", Format = OptionFormat.EqualsSeparated)]
    public string? SignBy { get; set; }

    /// <summary>
    /// skips stages in multi-stage builds which do not affect the final target (default true)
    /// </summary>
    [CliFlag("--skip-unused-stages")]
    public bool? SkipUnusedStages { get; set; }

    /// <summary>
    /// squash all image layers into a single layer
    /// </summary>
    [CliFlag("--squash")]
    public bool? Squash { get; set; }

    /// <summary>
    /// SSH agent socket or keys to expose to the build. (format: default|&lt;id&gt;[=&lt;socket&gt;|&lt;key&gt;[,&lt;key&gt;]])
    /// </summary>
    [CliOption("--ssh", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Ssh { get; set; }

    /// <summary>
    /// pass stdin into containers
    /// </summary>
    [CliFlag("--stdin")]
    public bool? Stdin { get; set; }

    /// <summary>
    /// tagged name to apply to the built image
    /// </summary>
    [CliOption("--tag", ShortForm = "-t", Format = OptionFormat.EqualsSeparated)]
    public string? Tag { get; set; }

    /// <summary>
    /// set the target build stage to build
    /// </summary>
    [CliOption("--target", Format = OptionFormat.EqualsSeparated)]
    public string? Target { get; set; }

    /// <summary>
    /// set created timestamp to the specified epoch seconds to allow for deterministic builds, defaults to current time
    /// </summary>
    [CliOption("--timestamp", Format = OptionFormat.EqualsSeparated)]
    public int? Timestamp { get; set; }

    /// <summary>
    /// require HTTPS and verify certificates when accessing the registry (default true)
    /// </summary>
    [CliFlag("--tls-verify")]
    public bool? TlsVerify { get; set; }

    /// <summary>
    /// ulimit options
    /// </summary>
    [CliOption("--ulimit", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Ulimit { get; set; }

    /// <summary>
    /// unset environment variable from final image
    /// </summary>
    [CliOption("--unsetenv", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Unsetenv { get; set; }

    /// <summary>
    /// unset label when inheriting labels from base image
    /// </summary>
    [CliOption("--unsetlabel", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Unsetlabel { get; set; }

    /// <summary>
    /// 'container', path of user namespace to join, or 'host'
    /// </summary>
    [CliOption("--userns", Format = OptionFormat.EqualsSeparated)]
    public string? Userns { get; set; }

    /// <summary>
    /// containerGID:hostGID:length GID mapping to use in user namespace
    /// </summary>
    [CliOption("--userns-gid-map", Format = OptionFormat.EqualsSeparated)]
    public string? UsernsGidMap { get; set; }

    /// <summary>
    /// name of entries from /etc/subgid to use to set user namespace GID mapping
    /// </summary>
    [CliOption("--userns-gid-map-group", Format = OptionFormat.EqualsSeparated)]
    public string? UsernsGidMapGroup { get; set; }

    /// <summary>
    /// containerUID:hostUID:length UID mapping to use in user namespace
    /// </summary>
    [CliOption("--userns-uid-map", Format = OptionFormat.EqualsSeparated)]
    public string? UsernsUidMap { get; set; }

    /// <summary>
    /// name of entries from /etc/subuid to use to set user namespace UID mapping
    /// </summary>
    [CliOption("--userns-uid-map-user", Format = OptionFormat.EqualsSeparated)]
    public string? UsernsUidMapUser { get; set; }

    /// <summary>
    /// private, :path of UTS namespace to join, or 'host'
    /// </summary>
    [CliOption("--uts", Format = OptionFormat.EqualsSeparated)]
    public string? Uts { get; set; }

    /// <summary>
    /// override the variant of the specified image
    /// </summary>
    [CliOption("--variant", Format = OptionFormat.EqualsSeparated)]
    public string? Variant { get; set; }

    /// <summary>
    /// bind mount a volume into the container
    /// </summary>
    [CliOption("--volume", ShortForm = "-v", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Volume { get; set; }

    [CliArgument(0, Placement = ArgumentPlacement.BeforeOptions)]
    public string? Context { get; set; }

}