External secret management integration in Kubernetes - Mini Project: Build & Apply

External Secret Management Integration in Kubernetes

📖 Scenario: You are managing a Kubernetes cluster for a small company. You want to keep sensitive information like database passwords outside of your cluster configuration files. To do this safely, you will use an external secret management tool and integrate it with Kubernetes.

🎯 Goal: Learn how to create a Kubernetes Secret that pulls data from an external secret manager using External Secrets Operator. You will create a secret definition, configure the external secret reference, and verify the secret is available inside the cluster.

📋 What You'll Learn

Create a Kubernetes Secret manifest referencing an external secret

Add configuration to specify the external secret provider and secret key

Apply the manifest to the cluster to create the external secret

Verify the secret data is available inside Kubernetes

💡 Why This Matters

🌍 Real World

Many companies keep sensitive data like passwords and API keys outside their Kubernetes manifests to improve security. External secret management tools help automate this securely.

💼 Career

DevOps engineers and Kubernetes administrators often integrate external secret managers to protect sensitive information and comply with security best practices.

1

Create ExternalSecret manifest skeleton

Create a YAML manifest named external-secret.yaml with kind ExternalSecret and apiVersion external-secrets.io/v1beta1. Set metadata name to my-db-secret and namespace to default. Add an empty spec section.

Kubernetes

# Create the ExternalSecret manifest skeleton with metadata and empty spec

Hint

Start by defining the basic structure of the ExternalSecret resource with metadata and an empty spec.

2

Add external secret provider configuration

In the spec section of external-secret.yaml, add secretStoreRef with name: my-secret-store and kind: SecretStore. Then add target with name: my-db-secret and creationPolicy: Owner.

Kubernetes

apiVersion: external-secrets.io/v1beta1
kind: ExternalSecret
metadata:
  name: my-db-secret
  namespace: default
spec:
  # Add secretStoreRef and target configuration here

Hint

Configure which external secret store to use and how to create the Kubernetes secret.

3

Add data mapping for external secret keys

Inside the spec of external-secret.yaml, add a data list with one item. The item should have secretKey: password and remoteRef: key: db-password to map the external secret key db-password to the Kubernetes secret key password.

Kubernetes

apiVersion: external-secrets.io/v1beta1
kind: ExternalSecret
metadata:
  name: my-db-secret
  namespace: default
spec:
  secretStoreRef:
    name: my-secret-store
    kind: SecretStore
  target:
    name: my-db-secret
    creationPolicy: Owner
  # Add data mapping here

Hint

Map the external secret key to the Kubernetes secret key using the data list.

4

Apply manifest and verify secret

Run kubectl apply -f external-secret.yaml to create the ExternalSecret. Then run kubectl get secret my-db-secret -o jsonpath='{.data.password}' to verify the secret data is present (base64 encoded).

Kubernetes

# Run the commands below in your terminal
# kubectl apply -f external-secret.yaml
# kubectl get secret my-db-secret -o jsonpath='{.data.password}'

Hint

The output should be the base64 encoded string of the password, for example cGFzc3dvcmQ= for 'password'.

Practice

1. What is the main purpose of using ExternalSecret in Kubernetes?

easy

A. To sync secrets from external secret stores into Kubernetes automatically

B. To create new Kubernetes namespaces

C. To monitor pod resource usage

D. To deploy applications without containers

Solution

1. Step 1: Understand ExternalSecret role

   ExternalSecret is designed to fetch and sync secrets from external secret management systems into Kubernetes.

2. Step 2: Compare options with purpose

   Only To sync secrets from external secret stores into Kubernetes automatically describes syncing secrets automatically, which matches ExternalSecret's main use.

3. Final Answer:

   To sync secrets from external secret stores into Kubernetes automatically -> Option A

4. Quick Check:

   ExternalSecret syncs external secrets = C [OK]

Hint: ExternalSecret = syncing external secrets into Kubernetes [OK]

Common Mistakes:

• Confusing ExternalSecret with namespace creation
• Thinking it manages pods or deployments
• Assuming it monitors resource usage

2. Which of the following is the correct syntax to define an ExternalSecret resource in Kubernetes?

easy

A. apiVersion: external-secrets.io/v1alpha1
kind: ExternalSecret
metadata:
name: my-secret
spec:
refreshInterval: 1h
secretStoreRef:
name: my-store
target:
name: synced-secret
data:
- secretKey: password
remoteRef:
key: prod/db-password

B. apiVersion: v1
kind: Secret
metadata:
name: my-secret
stringData:
password: prod/db-password

C. apiVersion: apps/v1
kind: Deployment
metadata:
name: secret-deployment
spec:
replicas: 1

D. apiVersion: external-secrets.io/v1
kind: SecretStore
metadata:
name: my-secret-store

Solution

1. Step 1: Identify ExternalSecret resource structure

   ExternalSecret uses apiVersion external-secrets.io/v1alpha1, kind ExternalSecret, and spec with secretStoreRef and data fields.

2. Step 2: Match syntax with options

   apiVersion: external-secrets.io/v1alpha1 kind: ExternalSecret metadata: name: my-secret spec: refreshInterval: 1h secretStoreRef: name: my-store target: name: synced-secret data: - secretKey: password remoteRef: key: prod/db-password matches the correct syntax for ExternalSecret resource definition including refreshInterval, secretStoreRef, and data mapping.

3. Final Answer:

   Correct ExternalSecret resource syntax -> Option A

4. Quick Check:

   ExternalSecret syntax = apiVersion: external-secrets.io/v1alpha1 kind: ExternalSecret metadata: name: my-secret spec: refreshInterval: 1h secretStoreRef: name: my-store target: name: synced-secret data: - secretKey: password remoteRef: key: prod/db-password [OK]

Hint: Look for apiVersion external-secrets.io and kind ExternalSecret [OK]

Common Mistakes:

• Using Secret kind instead of ExternalSecret
• Confusing SecretStore with ExternalSecret
• Wrong apiVersion or missing spec fields

3. Given this ExternalSecret YAML snippet, what will be the name of the Kubernetes Secret created?

spec:
  target:
    name: app-secret
  data:
  - secretKey: api-key
    remoteRef:
      key: prod/api-key

medium

A. prod/api-key

B. external-secret

C. api-key

D. app-secret

Solution

1. Step 1: Understand target.name in ExternalSecret

   The target.name field specifies the name of the Kubernetes Secret that will be created or updated.

2. Step 2: Identify the value in target.name

   Here, target.name is set to "app-secret", so the Kubernetes Secret will be named "app-secret".

3. Final Answer:

   app-secret -> Option D

4. Quick Check:

   target.name sets Secret name = app-secret [OK]

Hint: target.name is the Kubernetes Secret name [OK]

Common Mistakes:

• Confusing remoteRef.key with Secret name
• Using secretKey as Secret name
• Assuming default name external-secret

4. You applied an ExternalSecret manifest but the Kubernetes Secret is not created. Which is the most likely cause?

medium

A. The pod does not have enough CPU resources

B. The Kubernetes API server is down

C. The ExternalSecret controller is not installed or running in the cluster

D. The Deployment spec is missing replicas

Solution

1. Step 1: Identify role of ExternalSecret controller

   The ExternalSecret controller watches ExternalSecret resources and creates Kubernetes Secrets accordingly.

2. Step 2: Analyze why Secret is not created

   If the controller is missing or not running, ExternalSecret resources won't be processed, so no Secrets are created.

3. Final Answer:

   The ExternalSecret controller is not installed or running in the cluster -> Option C

4. Quick Check:

   Missing controller = no Secret creation [OK]

Hint: Check if ExternalSecret controller pod is running [OK]

Common Mistakes:

• Blaming pod CPU resources for Secret creation
• Assuming API server downtime without checking
• Confusing Deployment replicas with secret syncing

5. You want to sync a secret from AWS Secrets Manager into Kubernetes using ExternalSecret. Which two key configurations must you include in your ExternalSecret manifest?

hard

A. podSelector to select pods and replicas for scaling

B. secretStoreRef to specify AWS Secrets Manager and data with remoteRef key

C. container image and command to run the sync

D. nodeSelector to assign nodes and tolerations for scheduling

Solution

1. Step 1: Identify required ExternalSecret fields for AWS integration

   You must specify secretStoreRef to point to the AWS Secrets Manager store and data with remoteRef key to map the secret key.

2. Step 2: Exclude unrelated fields

   podSelector, replicas, container image, nodeSelector, and tolerations are unrelated to ExternalSecret syncing secrets.

3. Final Answer:

   secretStoreRef to specify AWS Secrets Manager and data with remoteRef key -> Option B

4. Quick Check:

   secretStoreRef + data.remoteRef = AWS secret sync [OK]

Hint: Use secretStoreRef and data.remoteRef for external secrets [OK]

Common Mistakes:

• Confusing pod or node selectors with secret syncing
• Trying to specify container image in ExternalSecret
• Missing secretStoreRef or data fields