Documentation
¶
Index ¶
- Variables
- func BuildEnvAlreadyExists(b BuildEnv, filename string, profile string) error
- func BuildEnvNotFound(b BuildEnv, filename string, profile string) error
- func MarshalConfigSet(cfgs parser.SkaffoldConfigSet) error
- func ProfileNotFound(profile string) error
- type BuildEnv
- type BuildEnvOptions
- type Formatter
- type ModulesOptions
- type Options
- type ProfilesOptions
Constants ¶
This section is empty.
Variables ¶
var ( ReadFileFunc = util.ReadConfiguration WriteFileFunc = func(filename string, data []byte) error { return ioutil.WriteFile(filename, data, 0644) } )
var ( GetConfigSet = parser.GetConfigSet BuildEnvs = struct { Unspecified BuildEnv Local BuildEnv GoogleCloudBuild BuildEnv Cluster BuildEnv }{ Local: "local", GoogleCloudBuild: "googleCloudBuild", Cluster: "cluster", } )
Functions ¶
func BuildEnvAlreadyExists ¶ added in v1.24.1
BuildEnvAlreadyExists specifies that there's an existing build environment definition for the same type.
func BuildEnvNotFound ¶ added in v1.26.0
BuildEnvNotFound specifies that the target build environment definition doesn't exist.
func MarshalConfigSet ¶ added in v1.24.1
func MarshalConfigSet(cfgs parser.SkaffoldConfigSet) error
MarshalConfigSet marshals out the slice of skaffold configs into the respective source `skaffold.yaml` files. It ensures that the unmodified configs are copied over as-is in their original positions in the file.
func ProfileNotFound ¶ added in v1.26.0
ProfileNotFound specifies that the target profile doesn't exist
Types ¶
type BuildEnvOptions ¶
type BuildEnvOptions struct {
// Profiles is the slice of profile names to activate.
Profiles []string
// Profile is a target profile to create or edit
Profile string
// Push specifies if images should be pushed to a registry.
Push *bool
// TryImportMissing specifies whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache
TryImportMissing *bool
// UseDockerCLI specifies to use `docker` command-line interface instead of Docker Engine APIs
UseDockerCLI *bool
// UseBuildkit specifies to use Buildkit to build Docker images
UseBuildkit *bool
// ProjectID is the GCP project ID
ProjectID string
// DiskSizeGb is the disk size of the VM that runs the build
DiskSizeGb int64
// MachineType is the type of VM that runs the build
MachineType string
// Timeout is the build timeout (in seconds)
Timeout string
// Concurrency is the number of artifacts to build concurrently. 0 means "no-limit"
Concurrency int
// PullSecretPath is the path to the Google Cloud service account secret key file.
PullSecretPath string
// PullSecretName is the name of the Kubernetes secret for pulling base images
// and pushing the final image.
PullSecretName string
// PullSecretMountPath is the path the pull secret will be mounted at within the running container.
PullSecretMountPath string
// Namespace is the Kubernetes namespace.
Namespace string
// DockerConfigPath is the path to the docker `config.json`.
DockerConfigPath string
// DockerConfigSecretName is the Kubernetes secret that contains the `config.json` Docker configuration.
DockerConfigSecretName string
// ServiceAccount describes the Kubernetes service account to use for the pod.
ServiceAccount string
// RunAsUser defines the UID to request for running the container.
RunAsUser int64
// RandomPullSecret adds a random UUID postfix to the default name of the pull secret to facilitate parallel builds, e.g. kaniko-secretdocker-cfgfd154022-c761-416f-8eb3-cf8258450b85.
RandomPullSecret bool
// RandomDockerConfigSecret adds a random UUID postfix to the default name of the docker secret to facilitate parallel builds, e.g. docker-cfgfd154022-c761-416f-8eb3-cf8258450b85.
RandomDockerConfigSecret bool
// Logging specifies the logging mode.
Logging string
// LogStreamingOption specifies the behavior when writing build logs to Google Cloud Storage.
LogStreamingOption string
// WorkerPool configures a pool of workers to run the build.
WorkerPool string
}
BuildEnvOptions holds flag values for various `skaffold inspect build-env` commands
type ModulesOptions ¶ added in v1.26.0
type ModulesOptions struct {
// IncludeAll specifies if unnamed modules should be included in the output list
IncludeAll bool
}
ModulesOptions holds flag values for various `skaffold inspect modules` commands
type Options ¶
type Options struct {
// Filename is the `skaffold.yaml` file path
Filename string
// RepoCacheDir is the directory for the remote git repository cache
RepoCacheDir string
// OutFormat is the output format. One of: json
OutFormat string
// Modules is the module filter for specific commands
Modules []string
// Strict specifies the error-tolerance for specific commands
Strict bool
ModulesOptions
ProfilesOptions
BuildEnvOptions
}
Options holds flag values for the various `skaffold inspect` commands
type ProfilesOptions ¶
type ProfilesOptions struct {
// BuildEnv is the build-env filter for command output. One of: local, googleCloudBuild, cluster.
BuildEnv BuildEnv
}
ProfilesOptions holds flag values for various `skaffold inspect profiles` commands