Managing Secrets using kubectl
Kubernetes Docs · نسخهٔ f284a9e7c87f · CC BY 4.0 برای مستندات و مجوزهای همراه
<!-- overview -->
This page shows you how to create, edit, manage, and delete Kubernetes {{<glossary_tooltip text="Secrets" term_id="secret">}} using the kubectl command-line tool.
{{% heading "prerequisites" %}}
{{< include "task-tutorial-prereqs.md" >}}
<!-- steps -->
Create a Secret
A Secret object stores sensitive data such as credentials used by Pods to access services. For example, you might need a Secret to store the username and password needed to access a database.
You can create the Secret by passing the raw data in the command, or by storing the credentials in files that you pass in the command. The following commands create a Secret that stores the username admin and the password S!B\*d$zDsb=.
Use raw data
Run the following command:
kubectl create secret generic db-user-pass \
--from-literal=username=admin \
--from-literal=password='S!B\*d$zDsb='You must use single quotes '' to escape special characters such as $, \, *, =, and ! in your strings. If you don't, your shell will interpret these characters.
{{< note >}} The stringData field for a Secret does not work well with server-side apply. {{< /note >}}
Use source files
- Store the credentials in files:
echo -n 'admin' > ./username.txt
echo -n 'S!B\*d$zDsb=' > ./password.txtThe -n flag ensures that the generated files do not have an extra newline character at the end of the text. This is important because when kubectl reads a file and encodes the content into a base64 string, the extra newline character gets encoded too. You do not need to escape special characters in strings that you include in a file.
- Pass the file paths in the
kubectlcommand:
kubectl create secret generic db-user-pass \
--from-file=./username.txt \
--from-file=./password.txtThe default key name is the file name. You can optionally set the key name using --from-file=[key=]source. For example:
kubectl create secret generic db-user-pass \
--from-file=username=./username.txt \
--from-file=password=./password.txtWith either method, the output is similar to:
secret/db-user-pass createdVerify the Secret {#verify-the-secret}
Check that the Secret was created:
kubectl get secretsThe output is similar to:
NAME TYPE DATA AGE
db-user-pass Opaque 2 51sView the details of the Secret:
kubectl describe secret db-user-passThe output is similar to:
Name: db-user-pass
Namespace: default
Labels: <none>
Annotations: <none>
Type: Opaque
Data
====
password: 12 bytes
username: 5 bytesThe commands kubectl get and kubectl describe avoid showing the contents of a Secret by default. This is to protect the Secret from being exposed accidentally, or from being stored in a terminal log.
Decode the Secret {#decoding-secret}
- View the contents of the Secret you created:
kubectl get secret db-user-pass -o jsonpath='{.data}'The output is similar to:
{ "password": "UyFCXCpkJHpEc2I9", "username": "YWRtaW4=" }- Decode the
passworddata:
echo 'UyFCXCpkJHpEc2I9' | base64 --decodeThe output is similar to:
S!B\*d$zDsb={{< caution >}} This is an example for documentation purposes. In practice, this method could cause the command with the encoded data to be stored in your shell history. Anyone with access to your computer could find the command and decode the secret. A better approach is to combine the view and decode commands. {{< /caution >}}
kubectl get secret db-user-pass -o jsonpath='{.data.password}' | base64 --decodeEdit a Secret {#edit-secret}
You can edit an existing Secret object unless it is immutable. To edit a Secret, run the following command:
kubectl edit secrets <secret-name>This opens your default editor and allows you to update the base64 encoded Secret values in the data field, such as in the following example:
# Please edit the object below. Lines beginning with a '#' will be ignored,
# and an empty file will abort the edit. If an error occurs while saving this file, it will be
# reopened with the relevant failures.
#
apiVersion: v1
data:
password: UyFCXCpkJHpEc2I9
username: YWRtaW4=
kind: Secret
metadata:
creationTimestamp: "2022-06-28T17:44:13Z"
name: db-user-pass
namespace: default
resourceVersion: "12708504"
uid: 91becd59-78fa-4c85-823f-6d44436242ac
type: OpaqueClean up
To delete a Secret, run the following command:
kubectl delete secret db-user-pass{{% heading "whatsnext" %}}
- Read more about the Secret concept
- Learn how to manage Secrets using config file
- Learn how to manage Secrets using kustomize