Skip to content

Commit 4069b3d

Browse files
authored
(DOCSP-20142) Separate out procedure into YAML steps file (#976)
* (DOCSP-20142) Recreating branch after conflict * (DOCSP-20142) Reference steps document.
1 parent 43514ee commit 4069b3d

File tree

2 files changed

+57
-45
lines changed

2 files changed

+57
-45
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
stepnum: 1
3+
ref: create-operator-credentials-create
4+
title: Create a new Kubernetes secret
5+
content: |
6+
7+
a. Ensure you have the Public and Private Keys for your desired
8+
|onprem| |svc-api-key|.
9+
10+
b. Invoke the following |k8s| command to create your secret:
11+
12+
.. code-block:: sh
13+
14+
kubectl -n <metadata.namespace> \
15+
create secret generic <mycredentials> \
16+
--from-literal="publicKey=<publicKey>" \
17+
--from-literal="privateKey=<privateKey>"
18+
19+
The ``-n`` flag limits the |k8s-ns| to which this secret applies.
20+
All MongoDB |k8s| resources must exist in the same namespace as the
21+
|k8s-secrets| and |k8s-configmaps|. The |k8s-op-short| doesn't use
22+
either the secrets or ConfigMaps.
23+
24+
.. note::
25+
26+
The deprecated version of this command specifies a ``user`` and ``publicApiKey``
27+
instead of a ``publicKey`` and ``privateKey``. |k8s-op-short| accepts
28+
either version for authentication.
29+
30+
---
31+
stepnum: 2
32+
ref: create-operator-credentials-verify
33+
title: Verify your new Kubernetes secret
34+
content: |
35+
36+
Invoke the following |k8s| command to verify your secret:
37+
38+
.. code-block:: sh
39+
40+
kubectl describe secrets/<mycredentials> -n <metadata.namespace>
41+
42+
This command returns a secret description in the shell:
43+
44+
.. code-block:: sh
45+
46+
Name: <mycredentials>
47+
Namespace: <metadata.namespace>
48+
Labels: <none>
49+
Annotations: <none>
50+
51+
Type: Opaque
52+
53+
Data
54+
====
55+
privateKey: 31 bytes
56+
publicKey: 22 bytes

source/tutorial/create-operator-credentials.txt

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -56,48 +56,4 @@ Procedure
5656

5757
To create your |k8s| secret:
5858

59-
1. Make sure you have the Public and Private Keys for your desired
60-
|onprem| |svc-api-key|.
61-
62-
2. Invoke the following |k8s| command to create your secret:
63-
64-
.. code-block:: sh
65-
66-
kubectl -n <metadata.namespace> \
67-
create secret generic <mycredentials> \
68-
--from-literal="publicKey=<publicKey>" \
69-
--from-literal="privateKey=<privateKey>"
70-
71-
The ``-n`` flag limits the |k8s-ns| to which this secret applies.
72-
All MongoDB |k8s| resources must exist in the same namespace as the
73-
|k8s-secrets| and |k8s-configmaps|. The |k8s-op-short| doesn't use
74-
either the secrets or ConfigMaps.
75-
76-
.. note::
77-
78-
The deprecated version of this command specifies a ``user`` and ``publicApiKey``
79-
instead of a ``publicKey`` and ``privateKey``. |k8s-op-short| accepts
80-
either version for authentication.
81-
82-
3. Invoke the following |k8s| command to verify your secret:
83-
84-
.. code-block:: sh
85-
86-
kubectl describe secrets/<mycredentials> -n <metadata.namespace>
87-
88-
This command returns a secret description in the shell:
89-
90-
.. code-block:: sh
91-
92-
Name: <mycredentials>
93-
Namespace: <metadata.namespace>
94-
Labels: <none>
95-
Annotations: <none>
96-
97-
Type: Opaque
98-
99-
Data
100-
====
101-
privateKey: 31 bytes
102-
publicKey: 22 bytes
103-
59+
.. include:: /includes/steps/create-operator-credentials.rst

0 commit comments

Comments
 (0)