Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
K
k3s
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jacklull
k3s
Commits
6a9ba0cf
Commit
6a9ba0cf
authored
Apr 10, 2015
by
Daniel Smith
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #6687 from ddysher/fix-doc
Small fix for secret doc
parents
1a2e4f8e
6679b850
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
10 deletions
+9
-10
secrets.md
docs/secrets.md
+9
-10
No files found.
docs/secrets.md
View file @
6a9ba0cf
# Secrets
# Secrets
Objects of type
`secret`
are intended to hold sensitive information, such as
Objects of type
`secret`
are intended to hold sensitive information, such as
passwords, OAuth tokens, and ssh keys. Putting this information in a
`secret`
passwords, OAuth tokens, and ssh keys. Putting this information in a
`secret`
is safer and more flexible than putting it verbatim in a
`pod`
definition or in
is safer and more flexible than putting it verbatim in a
`pod`
definition or in
a docker image.
a docker image.
### Creating and Using Secrets
### Creating and Using Secrets
To make use of secrets requires at least two steps:
To make use of secrets requires at least two steps:
...
@@ -21,7 +21,7 @@ This is an example of a simple secret, in json format:
...
@@ -21,7 +21,7 @@ This is an example of a simple secret, in json format:
"data"
:
{
"data"
:
{
"username"
:
"dmFsdWUtMQ0K"
,
"username"
:
"dmFsdWUtMQ0K"
,
"password"
:
"dmFsdWUtMg0KDQo="
"password"
:
"dmFsdWUtMg0KDQo="
}
}
}
}
```
```
...
@@ -110,7 +110,7 @@ To create a pod that uses an ssh key stored as a secret, we first need to create
...
@@ -110,7 +110,7 @@ To create a pod that uses an ssh key stored as a secret, we first need to create
{
{
"apiVersion"
:
"v1beta2"
,
"apiVersion"
:
"v1beta2"
,
"kind"
:
"Secret"
,
"kind"
:
"Secret"
,
"id"
:
"ssh-key-secret"
,
"id"
:
"ssh-key-secret"
,
"data"
:
{
"data"
:
{
"id-rsa.pub"
:
"dmFsdWUtMQ0K"
,
"id-rsa.pub"
:
"dmFsdWUtMQ0K"
,
"id-rsa"
:
"dmFsdWUtMg0KDQo="
"id-rsa"
:
"dmFsdWUtMg0KDQo="
...
@@ -272,7 +272,7 @@ Note how the specs for the two pods differ only in one field; this facilitates
...
@@ -272,7 +272,7 @@ Note how the specs for the two pods differ only in one field; this facilitates
creating pods with different capabilities from a common pod config template.
creating pods with different capabilities from a common pod config template.
### Use-case: Secret visible to one container in a pod
### Use-case: Secret visible to one container in a pod
<a
name=
"use-case-two-containers"
></a>
<a
name=
"use-case-two-containers"
></a>
Consider a program that needs to handle HTTP requests, do some complex business
Consider a program that needs to handle HTTP requests, do some complex business
logic, and then sign some messages with an HMAC. Because it has complex
logic, and then sign some messages with an HMAC. Because it has complex
...
@@ -296,7 +296,7 @@ Because `secret` objects can be created independently of the `pods` that use
...
@@ -296,7 +296,7 @@ Because `secret` objects can be created independently of the `pods` that use
them, there is less risk of the secret being exposed during the workflow of
them, there is less risk of the secret being exposed during the workflow of
creating, viewing, and editing pods. The system can also take additional
creating, viewing, and editing pods. The system can also take additional
precautions with
`secret`
objects, such as avoiding writing them to disk where
precautions with
`secret`
objects, such as avoiding writing them to disk where
possible.
possible.
A secret is only sent to a node if a pod on that node requires it. It is not
A secret is only sent to a node if a pod on that node requires it. It is not
written to disk. It is stored in a tmpfs. It is deleted once the pod that
written to disk. It is stored in a tmpfs. It is deleted once the pod that
...
@@ -308,7 +308,7 @@ Secrets are protected when transmitted over these channels.
...
@@ -308,7 +308,7 @@ Secrets are protected when transmitted over these channels.
There may be secrets for several pods on the same node. However, only the
There may be secrets for several pods on the same node. However, only the
secrets that a pod requests are potentially visible within its containers.
secrets that a pod requests are potentially visible within its containers.
Therefore, one Pod does not have access to the secrets of another pod.
Therefore, one Pod does not have access to the secrets of another pod.
There may be several containers in a pod. However, each container in a pod has
There may be several containers in a pod. However, each container in a pod has
to request the secret volume in its
`volumeMounts`
for it to be visible within
to request the secret volume in its
`volumeMounts`
for it to be visible within
...
@@ -318,16 +318,15 @@ Pod level](#use-case-two-containers).
...
@@ -318,16 +318,15 @@ Pod level](#use-case-two-containers).
### Risks
### Risks
-
Applications still need to protect the value of secret after reading it from the volume,
-
Applications still need to protect the value of secret after reading it from the volume,
such not accidentally logging it or transmitting it to an untrusted party.
such
as
not accidentally logging it or transmitting it to an untrusted party.
-
A user who can create a pod that uses a secret can also see the value of that secret. Even
-
A user who can create a pod that uses a secret can also see the value of that secret. Even
if apiserver policy does not allow that user to read the secret object, the user could
if apiserver policy does not allow that user to read the secret object, the user could
run a pod which exposes the secret.
run a pod which exposes the secret.
If multiple replicas of etcd are run, then the secrets will be shared between them.
If multiple replicas of etcd are run, then the secrets will be shared between them.
By default, etcd does not secure peer-to-peer communication with SSL/TLS, though this can be configured.
By default, etcd does not secure peer-to-peer communication with SSL/TLS, though this can be configured.
-
It is not possible currently to control which users of a kubernetes cluster can
-
It is not possible currently to control which users of a kubernetes cluster can
access a secret. Support for this is planned.
access a secret. Support for this is planned.
-
Currently, anyone with root on any node can read any secret from the apiserver,
-
Currently, anyone with root on any node can read any secret from the apiserver,
by impersonating the kubelet. It is a planned feature to only send secrets to
by impersonating the kubelet. It is a planned feature to only send secrets to
nodes that actually require them, to restrict the impact of a root exploit on a
nodes that actually require them, to restrict the impact of a root exploit on a
single node.
single node.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment