KUBERNETES(1)(kubernetes)

πŸ’– KUBERNETES(1)(kubernetes) πŸ’–

okay bestie, so this is the manual page for kubectl create secret tls β€” it lives in section 1 of the Kubernetes manual, and honestly? it's giving ✨keys and certs✨. Eric Paris wrote the original back in Jan 2015 and we're still thriving. let's get into it 🫢


🌸 NAME 🌸

kubectl create secret tls β€” make a TLS secret, no cap πŸ”


✨ SYNOPSIS ✨

kubectl create secret tls [OPTIONS]

that's it. that's the whole vibe. the cert and key come in as flags, not args, iykyk πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so basically you're creating a TLS secret out of a public/private key pair you already have. that's the whole point.

the public/private key pair must exist beforehand β€” like, you can't just manifest it, bestie, you have to actually have the files already 😭

and the public key certificate must be .PEM encoded and it has to match the given private key. if they don't match it's not gonna work, periodt. πŸ”₯


πŸŽ€ OPTIONS πŸŽ€

  • --allow-missing-template-keys=true β€” if this is true, it just ignores any errors in templates when a field or map key is missing from the template. note: this only applies to golang and jsonpath output formats, so don't expect it to save you elsewhere πŸ™ˆ
  • --append-hash=false β€” appends a hash of the secret to its name. cute little fingerprint situation ✨
  • --cert="" β€” path to the PEM encoded public key certificate. this is your .crt bestie πŸ“œ
  • --dry-run="none" β€” must be "none", "server", or "client". if it's the client strategy, it just prints the object that would be sent, without actually sending it. if it's the server strategy, it submits a server-side request without persisting the resource. so you can rehearse the whole thing without committing πŸ‘€
  • --field-manager="kubectl-create" β€” the name of the manager used to track field ownership. default is literally kubectl-create, iconic πŸ’…
  • --key="" β€” path to the private key associated with the given certificate πŸ”‘
  • -o, --output="" β€” output format. one of: json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file. pick your fighter πŸ₯Š
  • --save-config=false β€” if true, the configuration of the current object gets saved in its annotation. otherwise the annotation stays unchanged. this flag is useful when you wanna do a kubectl apply on this object later, so lowkey plan ahead πŸ“
  • --show-managed-fields=false β€” if true, it keeps the managedFields when printing objects in JSON or YAML format. nosy mode activated πŸ•΅οΈ
  • --template="" β€” template string, or path to a template file, to use when -o=go-template or -o=go-template-file. the template format is golang templates β€” [http://golang.org/pkg/text/template/#pkg-overview](http://golang.org/pkg/text/template/#pkg-overview). go off, template girlie 🧚
  • --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 performs server side validation if ServerSideFieldValidation is enabled on the api-server, but falls 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 behaves as "ignore" otherwise.
    • "false" or "ignore" will not perform any schema validation at all, and will silently drop any unknown or duplicate fields πŸ’€

πŸ’œ OPTIONS INHERITED FROM PARENT COMMANDS πŸ’œ

these are the family traits, bestie. they come from the parent command 🧬

  • --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, so stack 'em ✨
  • --as-uid="" β€” UID to impersonate for the operation
  • --as-user-extra=[] β€” user extras to impersonate for the operation. this flag can be repeated to specify multiple values for the same key
  • --cache-dir="/home/username/.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
  • --disable-compression=false β€” if true, opt out of response compression for all requests to the server πŸ“¦
  • --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
  • --kuberc="" β€” path to the kuberc file to use for preferences. this can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off
  • --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|trace) πŸ“Š
  • --profile-output="profile.pprof" β€” name of the file to write the profile to
  • --proxy-url="" β€” proxy URL to use for requests to the API server
  • --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 β€” --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
  • --warnings-as-errors=false β€” treat warnings received from the server as errors and exit with a non-zero exit code 😀

🌈 EXAMPLE 🌈

  # Create a new TLS secret named tls-secret with the given key pair
  kubectl create secret tls tls-secret --cert=path/to/tls.crt --key=path/to/tls.key

look at her go. main character energy fr fr πŸ‘‘


🌸 SEE ALSO 🌸


πŸ“œ 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! 🫢


and that's the whole page, bestie β€” brought to you by the Manuals manual set, User section, and it's the KUBERNETES(1)(kubernetes) page, dated way back in Jan 2015. she's vintage and she still slays. now go make that secret πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from