BuildahFromOptions.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>
/// Creates a new working container, either from scratch or using a specified
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
[ExcludeFromCodeCoverage]
[CliSubCommand("from")]
public record BuildahFromOptions : 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>
    /// 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. Use REGISTRY_AUTH_FILE environment variable to override
    /// </summary>
    [CliOption("--authfile", Format = OptionFormat.EqualsSeparated)]
    public string? Authfile { 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>
    /// write the container ID to the file
    /// </summary>
    [CliOption("--cidfile", Format = OptionFormat.EqualsSeparated)]
    public string? Cidfile { 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>
    /// 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>
    /// 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>
    /// format of the image manifest and metadata (default "oci")
    /// </summary>
    [CliOption("--format", ShortForm = "-f", Format = OptionFormat.EqualsSeparated)]
    public string? Format { 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 from
    /// </summary>
    [CliFlag("--help", ShortForm = "-h")]
    public bool? Help { get; set; }

    /// <summary>
    /// pass through HTTP Proxy environment variables (default true)
    /// </summary>
    [CliFlag("--http-proxy")]
    public bool? HttpProxy { 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>
    /// 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>
    /// name for the working container
    /// </summary>
    [CliOption("--name", Format = OptionFormat.EqualsSeparated)]
    public string? Name { 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>
    /// prefer OS instead of the running OS when pulling images (default "linux")
    /// </summary>
    [CliOption("--os", Format = OptionFormat.EqualsSeparated)]
    public string? Os { 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>
    /// don't output progress information when pulling images
    /// </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>
    /// 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>
    /// require HTTPS and verify certificates when accessing the registry. TLS verification cannot be used when talking to an insecure 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>
    /// '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; }

}