Creating a Secret¶

Scenario¶

A secret is a type of resource that holds sensitive data, such as authentication and key information. Its content is user-defined. After creating secrets, you can use them as files or environment variables in a containerized workload.

Notes and Constraints¶

Secrets cannot be used in static pods.

Procedure¶

Log in to the CCE console and click the cluster name to access the cluster console.
Choose ConfigMaps and Secrets in the navigation pane, click the Secrets tab, and click Create Secret in the upper right corner.

Configure parameters.

**Table 1** Parameters for creating a secret¶
Parameter	Description
Name	Name of the secret you create, which must be unique.
Namespace	Namespace to which the secret belongs. If you do not specify this parameter, the value default is used by default.
Description	Description of a secret.
Type	Type of the secret you create. Opaque: common secret. kubernetes.io/dockerconfigjson: a secret that stores the authentication information required for pulling images from a private repository. kubernetes.io/tls: Kubernetes TLS secret, which is used to store the certificate required by layer-7 load balancing Services. For details about examples of the kubernetes.io/tls secret and its description, see TLS secrets. IngressTLS: TLS secret provided by CCE to store the certificate required by layer-7 load balancing Services. Other: another type of secret, which is specified manually.
Secret Data	Workload secret data can be used in containers. If Secret Type is Opaque, click . In the dialog box displayed, enter a key-value pair and select Auto Base64 Encoding. If Secret Type is kubernetes.io/dockerconfigjson, enter the account and password for logging in to the private image repository. If Secret Type is kubernetes.io/tls or IngressTLS, upload the certificate file and private key file. Note A certificate is a self-signed or CA-signed credential used for identity authentication. A certificate request is a request for a signature with a private key.
Secret Label	Label of the secret. Enter a key-value pair and click Confirm.

Click OK.
The new secret is displayed in the key list.

Secret Resource File Configuration Example¶

This section describes configuration examples of secret resource description files.

Opaque type

The secret.yaml file is defined as shown below. The data field is filled in as a key-value pair, and the value field must be encoded using Base64. For details about the Base64 encoding method, see Base64 Encoding.

apiVersion: v1
kind: Secret
metadata:
  name: mysecret           #Secret name
  namespace: default       #Namespace. The default value is default.
data:
  <your_key>: <your_value>  # Enter a key-value pair. The value must be encoded using Base64.
type: Opaque

kubernetes.io/dockerconfigjson type
The secret.yaml file is defined as shown below. The value of .dockerconfigjson must be encoded using Base64. For details, see Base64 Encoding.
```
apiVersion: v1
kind: Secret
metadata:
  name: mysecret           #Secret name
  namespace: default       #Namespace. The default value is default.
data:
  .dockerconfigjson: eyJh*****    # Content encoded using Base64.
type: kubernetes.io/dockerconfigjson
```
To obtain the .dockerconfigjson content, perform the following steps:
1. Obtain the following login information of the image repository.
  - Image repository address: The section uses address as an example. Replace it with the actual address.
  - Username: The section uses username as an example. Replace it with the actual username.
  - Password: The section uses password as an example. Replace it with the actual password.
2. Use Base64 to encode the key-value pair username:password and fill the encoded content in 3.
```
echo -n "username:password" | base64
```
  Command output:
```
dXNlcm5hbWU6cGFzc3dvcmQ=
```
3. Use Base64 to encode the following JSON content:
```
echo -n '{"auths":{"address":{"username":"username","password":"password","auth":"dXNlcm5hbWU6cGFzc3dvcmQ="}}}' | base64
```
  Command output:
```
eyJhdXRocyI6eyJhZGRyZXNzIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0=
```
  The encoded content is the .dockerconfigjson content.

kubernetes.io/tls type

The value of tls.crt and tls.key must be encoded using Base64. For details, see Base64 Encoding.

kind: Secret
apiVersion: v1
metadata:
  name: mysecret           #Secret name
  namespace: default       #Namespace. The default value is default.
data:
  tls.crt: LS0tLS1CRU*****FURS0tLS0t  # Certificate content, which must be encoded using Base64.
  tls.key: LS0tLS1CRU*****VZLS0tLS0=  # Private key content, which must be encoded using Base64.
type: kubernetes.io/tls

IngressTLS type

The value of tls.crt and tls.key must be encoded using Base64. For details, see Base64 Encoding.

kind: Secret
apiVersion: v1
metadata:
  name: mysecret           #Secret name
  namespace: default       #Namespace. The default value is default.
data:
  tls.crt: LS0tLS1CRU*****FURS0tLS0t  # Certificate content, which must be encoded using Base64.
  tls.key: LS0tLS1CRU*****VZLS0tLS0=  # Private key content, which must be encoded using Base64.
type: IngressTLS

Creating a Secret Using kubectl¶

Use kubectl to access the cluster. For details, see Connecting to a Cluster Using kubectl.

Create and edit the Base64-encoded cce-secret.yaml file.

# echo -n "content to be encoded" | base64
******

vi cce-secret.yaml

The following YAML file uses the Opaque type as an example. For details about other types, see Secret Resource File Configuration Example.

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  <your_key>: <your_value>  # Enter a key-value pair. The value must be encoded using Base64.

Create a secret.
kubectl create -f cce-secret.yaml
You can query the secret after creation.
kubectl get secret -n default

Related Operations¶

After creating a secret, you can update or delete it as described in Table 2.

Note

The secret list contains system secret resources that can be queried only. The system secret resources cannot be updated or deleted.

**Table 2** Related Operations¶
Operation	Description
Editing a YAML file	Click Edit YAML in the row where the target secret resides to edit its YAML file.
Updating a secret	Select the name of the secret to be updated and click Update. Modify the secret data. For more information, see Table 1. Click OK.
Deleting a secret	Select the secret you want to delete and click Delete. Follow the prompts to delete the secret.
Deleting secrets in batches	Select the secrets to be deleted. Click Delete above the secret list. Follow the prompts to delete the secrets.

Base64 Encoding¶

To Base64-encode a string, run the echo -n content to be encoded | base64 command. The following is an example:

root@ubuntu:~# echo -n "content to be encoded" | base64
******

last updated: 2024-11-13 14:14 UTC - commit: cec5d99c0b383dc4229db0386260b57d330022c2