Skip to content

Commit 6b2f2ea

Browse files
authored
(DOCSP-44498) Refactor procedure (#13387)
* (DOCSP-44498) Refactor procedure - Adopt imperative tone re: --gov flag - Cut superfluous steps based on installation without --gov flag * (DOCSP-44498) Error fix. * Trigger new build * (DOCSP-44498) Fix broken link. * (DOCSP-44498) Fix broken link
1 parent b6d0fef commit 6b2f2ea

File tree

3 files changed

+14
-72
lines changed

3 files changed

+14
-72
lines changed
Lines changed: 7 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _ak8so-for-gov-ref:
22

3-
==============================================
4-
Configure |ak8so| for |service| for Government
5-
==============================================
3+
============================================================
4+
|ak8so| for |service| for Government Quick Start
5+
============================================================
66

77
.. default-domain:: mongodb
88

@@ -25,13 +25,9 @@ This page describes how to configure the |ak8so| to manage resources in
2525
Prerequisites
2626
-------------
2727

28-
You must install the |ak8so|. If you install the |ak8so| using
29-
{+atlas-cli+} with the ``--gov`` flag, you can skip steps 1 - 3 in the
30-
following procedure. If you don't specify ``--gov`` flag for installing
31-
the |ak8so|, complete all the steps in the following procedure.
32-
33-
To learn more about installing the |ak8so| using the {+atlas-cli+}, see
34-
:ref:`ak8so-quick-start-ref`.
28+
You must install the |ak8so| using {+atlas-cli+} with the ``--gov``
29+
flag. To learn more about installing the |ak8so| using the
30+
{+atlas-cli+}, see :ref:`ak8so-quick-start-ref`.
3531

3632
Procedure
3733
---------
@@ -41,61 +37,6 @@ After you install the |ak8so|, do the following:
4137
.. procedure::
4238
:style: normal
4339

44-
.. step:: Edit the |ak8so| Deployment manifest to set the target to the domain of |service| for Government.
45-
46-
For example, to edit using ``kubectl``:
47-
48-
.. code-block:: shell
49-
:copyable: true
50-
51-
kubectl edit deployments.apps -n default <your-mongodb-atlas-operator>
52-
53-
.. step:: Locate the ``atlas-domain`` setting under ``spec.containers.args`` in the file.
54-
55-
.. code-block:: shell
56-
:copyable: false
57-
:emphasize-lines: 19
58-
59-
apiVersion: apps/v1
60-
kind: Deployment
61-
metadata:
62-
...
63-
spec:
64-
progressDeadlineSeconds: 600
65-
replicas: 1
66-
revisionHistoryLimit: 10
67-
selector:
68-
...
69-
strategy:
70-
...
71-
template:
72-
metadata:
73-
...
74-
spec:
75-
containers:
76-
- args:
77-
- --atlas-domain=https://cloud.mongodb.com/
78-
- --leader-elect
79-
- --health-probe-bind-address=:8081
80-
- --metrics-bind-address=127.0.0.1:8080
81-
- --log-level=info
82-
- --log-encoder=json
83-
command:
84-
- /manager
85-
env:
86-
- name: OPERATOR_POD_NAME
87-
...
88-
89-
.. step:: Modify the domain to set the target to |service| for Government.
90-
91-
To configure the domain, replace the value of ``--atlas-domain``
92-
with the following |url|:
93-
94-
.. code-block:: shell
95-
:copyable: true
96-
97-
https://cloud.mongodbgov.com/
98-
9940
.. step:: Deploy |ak8so|.
10041

10142
Follow the procedure in the :ref:`ak8so-quick-start-ref` to deploy
@@ -108,4 +49,4 @@ After you install the |ak8so|, do the following:
10849
|service| for Government. If you omit the
10950
``spec.regionUsageRestrictions`` parameter,
11051
this setting defaults to ``GOV_REGIONS_ONLY`` To learn more, see
111-
:setting:`spec.regionUsageRestrictions`.
52+
:setting:`spec.regionUsageRestrictions`.

content/atlas-operator/upcoming/source/atlasdatafederation-custom-resource.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@
2020
|ak8so| doesn't support the ``AtlasDataFederation`` custom resource for
2121
|service| for Government.
2222

23-
The ``AtlasDataFederation`` custom resource configures {+fdi+} in |service|.
24-
When you create the ``AtlasDataFederation`` custom resource, |ak8so| tries
25-
to create or update a :ref:`{+fdi+} <config-federated-db>`
26-
in |service|. You can use an {+fdi+} to run :ref:`federated queries <atlas-data-federation>`.
23+
The ``AtlasDataFederation`` custom resource configures a {+fdi+} in
24+
|service|. When you create the ``AtlasDataFederation`` custom
25+
resource, |ak8so| tries to create or update a {+fdi+} in
26+
|service|. You can use an {+fdi+} to run :ref:`federated queries
27+
<atlas-data-federation>`.
2728

2829
.. include:: /includes/fact-ak8so-crds.rst
2930

content/atlas-operator/v2.5/source/ak8so-unified-access.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ in the :ref:`atlasproject-custom-resource`.
2323
<ak8so-independent-crd>`, you cannot configure |aws| |iam|
2424
authentication using ``atlasProject`` parameters. To configure
2525
|aws| |iam| authentication for your |service| project directly,
26-
please see :ref:`aws-iam-authentication <Set Up Authentication with
27-
AWS IAM>`.
26+
please see :atlas:`Set Up Authentication with
27+
AWS IAM </security/aws-iam-authentication>`.
2828

2929
Prerequisites
3030
-------------

0 commit comments

Comments
 (0)