KubectlCreateSecretDockerRegistrySettings Class

Summary

Create a new secret for use with Docker registries. Dockercfg secrets are used to authenticate against Docker registries. When using the Docker command line to push images, you can authenticate to a given registry by running: '$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'. That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional. When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlCreateSecretDockerRegistrySettings"] class Type type-node

Syntax

public sealed class KubectlCreateSecretDockerRegistrySettings : AutoToolSettings

Examples

# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
AllowMissingTemplateKeys Nullable<bool>
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
AppendHash Nullable<bool>
--append-hash Append a hash of the secret to its name.
DockerEmail string
--docker-email Email for Docker registry
DockerPassword string
--docker-password Password for Docker registry authentication
DockerServer string
--docker-server //index.docker.io/v1/': Server location for Docker registry
DockerUsername string
--docker-username Username for Docker registry authentication
DryRun Nullable<bool>
--dry-run If true, only print the object that would be sent, without sending it.
FromFile string
--from-file Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key.
Generator string
--generator The name of the API generator to use.
Output string
-o, --output Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
SaveConfig Nullable<bool>
--save-config If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
Template string
--template Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
Validate Nullable<bool>
--validate If true, use a schema to validate the input before sending it

Extension Methods

Name Value Summary
Dump<KubectlCreateSecretDockerRegistrySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlCreateSecretDockerRegistrySettings>(KubectlCreateSecretDockerRegistrySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlCreateSecretDockerRegistrySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlCreateSecretDockerRegistrySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlCreateSecretDockerRegistrySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlCreateSecretDockerRegistrySettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin