kubectl-create-secret-generic - Man Page

Create a secret from a local file, directory, or literal value

Eric Paris Jan 2015

Synopsis

kubectl create secret generic [Options]

Description

Create a secret based on a file, directory, or specified literal value.

A single secret may package one or more key/value pairs.

When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key.

When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

Options

--allow-missing-template-keys=true 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.

--append-hash=false Append a hash of the secret to its name.

--dry-run="none" Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.

--field-manager="kubectl-create" Name of the manager used to track field ownership.

--from-env-file=[] Specify the path to a file to read lines of key=val pairs to create a secret.

--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.

--from-literal=[] Specify a key and literal value to insert in secret (i.e. mykey=somevalue)

-o, --output="" Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).

--save-config=false 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.

--show-managed-fields=false If true, keep the managedFields when printing objects in JSON or YAML format.

--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].

--type="" The type of secret to create

--validate="strict" Must be one of: strict (or true), warn, ignore (or false). "true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.

Options Inherited from Parent Commands

--as="" Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

--as-group=[] Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid="" UID to impersonate for the operation.

--azure-container-registry-config="" Path to the file containing Azure container registry configuration information.

--cache-dir="/builddir/.kube/cache" Default cache directory

--certificate-authority="" Path to a cert file for the certificate authority

--client-certificate="" Path to a client certificate file for TLS

--client-key="" Path to a client key file for TLS

--cluster="" The name of the kubeconfig cluster to use

--context="" The name of the kubeconfig context to use

--insecure-skip-tls-verify=false If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--kubeconfig="" Path to the kubeconfig file to use for CLI requests.

--match-server-version=false Require server version to match client version

-n, --namespace="" If present, the namespace scope for this CLI request

--password="" Password for basic authentication to the API server

--profile="none" Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output="profile.pprof" Name of the file to write the profile to

--request-timeout="0" The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server="" The address and port of the Kubernetes API server

--tls-server-name="" Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

--token="" Bearer token for authentication to the API server

--user="" The name of the kubeconfig user to use

--username="" Username for basic authentication to the API server

--version=false Print version information and quit

--warnings-as-errors=false Treat warnings received from the server as errors and exit with a non-zero exit code

Example

  # Create a new secret named my-secret with keys for each file in folder bar
  kubectl create secret generic my-secret --from-file=path/to/bar
  
  # Create a new secret named my-secret with specified keys instead of names on disk
  kubectl create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-file=ssh-publickey=path/to/id_rsa.pub
  
  # Create a new secret named my-secret with key1=supersecret and key2=topsecret
  kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
  
  # Create a new secret named my-secret using a combination of a file and a literal
  kubectl create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-literal=passphrase=topsecret
  
  # Create a new secret named my-secret from env files
  kubectl create secret generic my-secret --from-env-file=path/to/foo.env --from-env-file=path/to/bar.env

See Also

kubectl-create-secret(1),

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Referenced By

kubectl-create-secret(1).

User Manuals