Skip to content

Commit 32388ee

Browse files
corryrootjwilliams-mongo
authored andcommitted
(DOCSP-20950): Updated ConfigMap step. (#983)
* (DOCSP-20950): Updated ConfigMap step. * (DOCSP-20950) Incorporated JW's feedback. * (DOCSP-20950) Incorporated JW's feedback.
1 parent 1386073 commit 32388ee

File tree

3 files changed

+35
-36
lines changed

3 files changed

+35
-36
lines changed

source/includes/list-tables/configmap-keys-curl.rst

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,30 @@
77
- Description
88
- Example
99

10-
* - ``configmap-name``
10+
* - ``metadata.name``
1111
- string
1212
- Name of the |k8s| |k8s-obj|.
1313

1414
.. include:: /includes/fact-resource-name-char-limit.rst
1515

1616
.. seealso::
1717

18-
- :setting:`metadata.name`
1918
- |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
2019
This name must follow :rfc:`RFC1123 <1123>` naming
2120
conventions, using only lowercase alphanumeric
2221
characters, ``-`` or ``.``, and must start and end with an
2322
alphanumeric character.
2423

25-
- ``myconfigmap``
24+
- ``my-project``
2625

27-
* - ``baseUrl``
26+
* - ``metadata.namespace``
2827
- string
29-
- |url| to your |application| including the |fqdn| and port
30-
number.
31-
32-
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
33-
34-
.. note::
28+
- |k8s| |k8s-ns| where the |k8s-op-short| creates this
29+
|k8s-mdbrsc| and other |k8s-objs|.
3530

36-
If you're using |cloud-short|, set the ``data.baseUrl`` value
37-
to ``https://cloud.mongodb.com``.
38-
39-
- ``https://ops.example.com:8443``
31+
- ``mongodb``
4032

41-
* - ``projectName``
33+
* - ``data.projectName``
4234
- string
4335
- Label for your |mms|
4436
:opsmgr:`Project </tutorial/manage-projects>`.
@@ -57,9 +49,9 @@
5749
Each card in this list represents the
5850
combination of one |com| **Organization** and **Project**.
5951

60-
- ``Development``
52+
- ``myProjectName``
6153

62-
* - ``orgId``
54+
* - ``data.orgId``
6355
- string
6456
- 24 character hex string that uniquely
6557
identifies your
@@ -100,9 +92,18 @@
10092
role to create a new project within an existing
10193
|com| organization.
10294

103-
- ``5cc9b333dde384a625a6615``
104-
95+
- ``5b890e0feacf0b76ff3e7183``
96+
97+
* - ``data.baseUrl``
98+
- string
99+
- |url| to your |application| including the |fqdn| and port
100+
number.
105101

102+
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
106103

104+
.. note::
107105

106+
If you're using |cloud-short|, set the ``data.baseUrl`` value
107+
to ``https://cloud.mongodb.com``.
108108

109+
- ``https://ops.example.com:8443``

source/includes/steps-create-k8s-configmap.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,18 @@ content: |
1313
1414
.. code-block:: sh
1515
16-
kubectl create configmap <configmap-name> \
17-
--from-literal="baseUrl=<myOpsManagerURL>" \
18-
--from-literal="projectName=<myOpsManagerProjectName>" \ #Optional
19-
--from-literal="orgId=<orgID>" #Required for Global API Keys
16+
cat <<EOF | kubectl apply -f -
17+
apiVersion: v1
18+
kind: ConfigMap
19+
metadata:
20+
name: my-project
21+
namespace: mongodb
22+
data:
23+
projectName: myProjectName # this is an optional parameter
24+
orgId: 5b890e0feacf0b76ff3e7183 # this is an optional parameter
25+
baseUrl: https://ops.example.com:8443
26+
27+
EOF
2028
2129
.. include:: /includes/list-tables/configmap-keys-curl.rst
2230

source/includes/steps-openshift-quick-start.yaml

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,9 @@ stepnum: 7
9797
level: 4
9898
ref: copy-k8s-configmap-openshift
9999
title: "Invoke the following command to create a ConfigMap."
100-
content: |
101-
.. note::
102-
103-
Provide your values for the following parameters. To learn more,
104-
see the :doc:`parameter descriptions
105-
</tutorial/create-project-using-configmap>`.
106-
107-
.. code-block:: sh
108-
109-
kubectl create configmap myconfigmap \
110-
--from-literal="baseUrl=<myOpsManagerURL>" \
111-
--from-literal="projectName=<myOpsManagerProjectName>" \ #Optional
112-
--from-literal="orgId=<orgID>" #Required for Global API Keys
100+
source:
101+
file: steps-create-k8s-configmap.yaml
102+
ref: copy-k8s-configmap
113103

114104
---
115105
stepnum: 8

0 commit comments

Comments
 (0)