params

package
v0.14.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 31, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProjectName                  string = "project-name"
	ProjectNameDesc              string = "project name to identify the instance of the stack"
	BackedURL                    string = "backed-url"
	BackedURLDesc                string = "" /* 219-byte string literal not displayed */
	ConnectionDetailsOutput      string = "conn-details-output"
	ConnectionDetailsOutputDesc  string = "path to export host connection information (host, username and privateKey)"
	Debug                        string = "debug"
	DebugDesc                    string = "Enable debug traces and set verbosity to max. Typically to get information to troubleshooting an issue."
	DebugLevel                   string = "debug-level"
	DebugLevelDefault            uint   = 3
	DebugLevelDesc               string = "Set the level of verbosity on debug. You can set from minimum 1 to max 9."
	LinuxArch                    string = "arch"
	LinuxArchDesc                string = "architecture for the machine. Allowed x86_64 or arm64"
	LinuxArchDefault             string = "x86_64"
	SupportedHostID              string = "host-id"
	SupportedHostIDDesc          string = "host id from supported hosts list"
	AvailabilityZones            string = "availability-zones"
	AvailabilityZonesDesc        string = "List of comma separated azs to check. If empty all will be searched"
	RHMajorVersion               string = "rh-major-version"
	RHMajorVersionDesc           string = "major version for rhel image 7, 8 or 9"
	RHSubcriptionUsername        string = "rh-subscription-username"
	RHSubcriptionUsernameDesc    string = "username for rhel subcription"
	RHSubcriptionPassword        string = "rh-subscription-password"
	RHSubcriptionPasswordDesc    string = "password for rhel subcription"
	FedoraMajorVersion           string = "fedora-major-version"
	FedoraMajorVersionDesc       string = "major version for fedora image 36, 37, ..."
	MacOSMajorVersion            string = "macos-major-version"
	MacOSMajorVersionDesc        string = "major version for macos image 12, 13, ..."
	AMIIDName                    string = "ami-id"
	AMIIDDesc                    string = "id for the source ami"
	AMINameName                  string = "ami-name"
	AMINameDesc                  string = "name for the source ami"
	AMISourceRegion              string = "ami-region"
	AMISourceRegionDesc          string = "region for the ami to be copied worldwide"
	Tags                         string = "tags"
	TagsDesc                     string = "tags to add on each resource (--tags name1=value1,name2=value2)"
	GHActionsRunnerTokenDesc     string = "Token needed for registering the Github Actions Runner token"
	GHActionsRunnerRepoDesc      string = "Full URL of the repository where the Github Actions Runner should be registered"
	GHActionsRunnerOrgDesc       string = "GitHub organization name where the runner should be registered (mutually exclusive with --ghactions-runner-repo)"
	GHActionsRunnerLabelsDesc    string = "List of labels separated by comma to be added to the self-hosted runner"
	GHActionsRunnerEphemeralDesc string = "Configure the runner as ephemeral: it executes a single job then deregisters automatically"

	CreateCmdName  string = "create"
	DestroyCmdName string = "destroy"

	GlRunnerConcurrent             string = "glrunner-concurrent"
	GlRunnerConcurrentDesc         string = "maximum number of jobs the runner executes concurrently"
	GlRunnerConcurrentPowerDefault int    = 2
	GlRunnerConcurrentS390xDefault int    = 3

	//RHEL
	SubsUsername              string = "rh-subscription-username"
	SubsUsernameDesc          string = "username to register the subscription"
	SubsUserpass              string = "rh-subscription-password"
	SubsUserpassDesc          string = "password to register the subscription"
	ProfileSNC                string = "snc"
	ProfileSNCDesc            string = "" /* 126-byte string literal not displayed */
	RhelVersion               string = "version"
	RhelVersionDesc           string = "version for the RHEL OS"
	RhelVersionDefault        string = "9.4"
	RhelAIVersion             string = "version"
	RhelAIVersionDesc         string = "version for the RHELAI OS"
	RhelAIVersionDefault      string = "3.0.0"
	RhelAIAccelerator         string = "accelerator"
	RhelAIAccelearatorDesc    string = "accelerator type. Valid types: cuda and rocm"
	RhelAIAccelearatorDefault string = "cuda"
	RhelAICustomImage         string = "custom-image"
	RhelAICustomImageDesc     string = "custom image name to spin RHEL AI OS (AMI name for AWS, image name for Azure)"
	RhelAIMarketplace         string = "marketplace"
	RhelAIMarketplaceDesc     string = "use the cloud provider's marketplace RHEL AI image instead of a shared gallery or custom image"
	RhelAIModel               string = "model"
	RhelAIModelDesc           string = "Hugging Face model ID for RHAIIS (e.g. meta-llama/Llama-3.2-1B-Instruct)"
	RhelAIHFToken             string = "hf-token"
	RhelAIHFTokenDesc         string = "Hugging Face Hub token for model download"
	RhelAIAPIKey              string = "api-key"
	RhelAIAPIKeyDesc          string = "API key to enforce secure connections to vLLM"
	RhelAIAutoStart           string = "auto-start"
	RhelAIAutoStartDesc       string = "automatically configure and start RHAIIS after provisioning"
	RhelAIExposePorts         string = "expose-ports"
	RhelAIExposePortsDesc     string = "comma-separated list of ports to expose through the load balancer and security group (e.g. 8000,8080)"
	RhelAIVLLMExtraArgs       string = "vllm-extra-args"
	RhelAIVLLMExtraArgsDesc   string = "" /* 141-byte string literal not displayed */

	// Serverless
	Timeout        string = "timeout"
	TimeoutDesc    string = "" /* 167-byte string literal not displayed */
	Serverless     string = "serverless"
	ServerlessDesc string = "if serverless is set the command will be executed as a serverless action."

	// Destroy
	ForceDestroy     string = "force-destroy"
	ForceDestroyDesc string = "if force-destroy is set the command will destroy even if there is a lock."
	KeepState        string = "keep-state"
	KeepStateDesc    string = "keep Pulumi state files in backend storage after successful destroy (by default, state files are removed)"

	// IBM Cloud
	SubnetID              string = "subnet-id"
	SubnetIDDesc          string = "ID of an existing VPC subnet to deploy the instance into"
	WorkspaceID           string = "workspace-id"
	WorkspaceIDDesc       string = "ID of an existing Power VS workspace (cloud instance)"
	PIPrivateSubnetID     string = "pi-private-subnet-id"
	PIPrivateSubnetIDDesc string = "ID of an existing Power VS private subnet to attach the instance to"
	VPCPublicSubnetID     string = "vpc-public-subnet-id"
	VPCPublicSubnetIDDesc string = "ID of an existing VPC subnet (with public gateway, connected to Transit Gateway) for the SSH bastion"

	// IBM Power instance sizing
	PIMemory             string  = "pi-memory"
	PIMemoryDesc         string  = "PowerVS instance memory in GB"
	PIMemoryDefault      float64 = 96.0
	PIProcessors         string  = "pi-processors"
	PIProcessorsDesc     string  = "PowerVS instance processor count (shared cores)"
	PIProcessorsDefault  float64 = 24.0
	PIProcType           string  = "pi-proc-type"
	PIProcTypeDesc       string  = "PowerVS processor type (shared, dedicated, capped)"
	PIProcTypeDefault    string  = "shared"
	PISysType            string  = "pi-sys-type"
	PISysTypeDesc        string  = "PowerVS system type (e.g. e1080, s1022, s1122)"
	PISysTypeDefault     string  = "e1080"
	PIStorageType        string  = "pi-storage-type"
	PIStorageTypeDesc    string  = "PowerVS storage tier for instance and data volume (tier1, tier3)"
	PIStorageTypeDefault string  = "tier1"
	PIDiskSize           string  = "pi-disk-size"
	PIDiskSizeDesc       string  = "data volume size in GB attached to the PowerVS instance"
	PIDiskSizeDefault    int     = 300

	// IBM Z instance sizing
	IZProfile         string = "iz-profile"
	IZProfileDesc     string = "IBM Z VPC instance profile name"
	IZProfileDefault  string = "mz2-16x128"
	IZDiskSize        string = "iz-disk-size"
	IZDiskSizeDesc    string = "boot volume size in GB for the IBM Z instance (10-250 for general-purpose profile)"
	IZDiskSizeDefault int    = 250

	OtelAppCode        string = "otel-app-code"
	OtelAppCodeDesc    string = "" /* 154-byte string literal not displayed */
	OtelAuthToken      string = "otel-auth-token"
	OtelAuthTokenDesc  string = "OpenTelemetry authentication token (UUID) used to authenticate against the OTLP endpoint"
	OtelEndpoint       string = "otel-endpoint"
	OtelEndpointDesc   string = "OTLP HTTP endpoint to export logs to"
	OtelIndex          string = "otel-index"
	OtelIndexDesc      string = "Splunk index name for log routing (e.g. rh_linux)"
	OtelExtraAttrs     string = "otel-extra-attrs"
	OtelExtraAttrsDesc string = "Additional resource attributes to attach to all otelcol log records (key=value pairs)"

	// Kind
	KindCmd                   = "kind"
	KindCmdDesc               = "Manage a Kind cluster. This is not intended for production use"
	KindK8SVersion            = "version"
	KindK8SVersionDesc        = "version for k8s offered through Kind."
	KindK8SVersionDefault     = "v1.34"
	KindExtraPortMappings     = "extra-port-mappings"
	KindExtraPortMappingsDesc = "" /* 223-byte string literal not displayed */

	// Network
	ServiceEndpoints = "service-endpoints"
)

Variables

This section is empty.

Functions

func AddCirrusFlags

func AddCirrusFlags(fs *pflag.FlagSet)

func AddCommonFlags

func AddCommonFlags(fs *pflag.FlagSet)

func AddComputeRequestFlags added in v0.9.6

func AddComputeRequestFlags(fs *pflag.FlagSet)

func AddDebugFlags

func AddDebugFlags(fs *pflag.FlagSet)

func AddGHActionsFlags added in v0.9.6

func AddGHActionsFlags(fs *pflag.FlagSet)

func AddGitLabRunnerFlags added in v0.10.0

func AddGitLabRunnerFlags(fs *pflag.FlagSet)

func AddNetworkFlags added in v0.12.0

func AddNetworkFlags(fs *pflag.FlagSet, desc string)

func AddSpotFlags added in v0.9.6

func AddSpotFlags(fs *pflag.FlagSet)

func CirrusPersistentWorkerArgs added in v0.9.6

func CirrusPersistentWorkerArgs() *cirrus.PersistentWorkerArgs

func ComputeRequestArgs added in v0.9.6

func ComputeRequestArgs() *cr.ComputeRequestArgs

func GitLabRunnerArgs added in v0.10.0

func GitLabRunnerArgs(arch *gitlab.Arch) *gitlab.GitLabRunnerArgs

func GithubRunnerArgs added in v0.9.6

func GithubRunnerArgs(arch *github.Arch) *github.GithubRunnerArgs

func GithubRunnerDeregisterArgs added in v0.14.3

func GithubRunnerDeregisterArgs(arch *github.Arch) *github.GithubRunnerArgs

GithubRunnerDeregisterArgs returns the GitHub credentials needed to deregister a runner at destroy time. Unlike GithubRunnerArgs it never generates a registration token, so it is safe to call without consuming a one-time token.

func LinuxGitLabArch added in v0.14.1

func LinuxGitLabArch() *gitlab.Arch

func LinuxGithubArch added in v0.14.3

func LinuxGithubArch() *github.Arch

func MACArchAsCirrusArch added in v0.9.6

func MACArchAsCirrusArch(arch string) *cirrus.Arch

func MACArchAsGitLabArch added in v0.10.0

func MACArchAsGitLabArch(arch string) *gitlab.Arch

func NetworkServiceEndpoints added in v0.12.0

func NetworkServiceEndpoints() []string

func SpotArgs added in v0.9.6

func SpotArgs() *spotTypes.SpotArgs

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL