Skip to content

Commit b66b64a

Browse files
DOCSP-48106 -- add ako dry run commands (#948)
* DOCSP-48106 -- add ako dry run commands * DOCSP-48106 -- add ako dry run commands * DOCSP-48106 -- add ako dry run commands * DOCSP-48106 -- copy review
1 parent 1e87641 commit b66b64a

File tree

4 files changed

+89
-1
lines changed

4 files changed

+89
-1
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _atlas-kubernetes-dry-run:
2+
3+
========================
4+
atlas kubernetes dry-run
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Deploy and run Atlas Kubernetes Operator in dry-run mode.
16+
17+
This command deploys the Atlas Kubernetes operator with the dry-run mode.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas kubernetes dry-run [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Options
30+
-------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - -h, --help
41+
-
42+
- false
43+
- help for dry-run
44+
* - --operatorVersion
45+
- string
46+
- false
47+
- Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.7.0".
48+
* - --orgId
49+
- string
50+
- false
51+
- Organization ID to use. This option overrides the settings in the configuration file or environment variable.
52+
* - --targetNamespace
53+
- string
54+
- false
55+
- Namespaces to use for generated Kubernetes entities.
56+
* - --watch
57+
-
58+
- false
59+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option.
60+
* - --watchNamespace
61+
- strings
62+
- false
63+
- List that contains namespaces that the Operator listens to.
64+
* - --watchTimeout
65+
- int
66+
- false
67+
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. This value defaults to 120.
68+
69+
Inherited Options
70+
-----------------
71+
72+
.. list-table::
73+
:header-rows: 1
74+
:widths: 20 10 10 60
75+
76+
* - Name
77+
- Type
78+
- Required
79+
- Description
80+
* - -P, --profile
81+
- string
82+
- false
83+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

source/command/atlas-kubernetes-operator-install.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Options
4444
-
4545
- false
4646
- Flag that indicates whether to configure Atlas for Government as a target of the operator.
47+
* - --configOnly
48+
-
49+
- false
50+
- Flag that indicates whether to generate only the Operator configuration files without installing the Operator
4751
* - -h, --help
4852
-
4953
- false

source/command/atlas-kubernetes-operator.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,5 @@ Related Commands
5858
:titlesonly:
5959

6060
install </command/atlas-kubernetes-operator-install>
61+
dry-run </command/atlas-kubernetes-dry-run>
6162

source/command/atlas-kubernetes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Related Commands
4040
----------------
4141

4242
* :ref:`atlas-kubernetes-config` - Manage Kubernetes configuration resources.
43+
* :ref:`atlas-kubernetes-dry-run` - Deploy and run Atlas Kubernetes Operator in dry-run mode
4344
* :ref:`atlas-kubernetes-operator` - Manage Atlas Kubernetes Operator.
4445

4546

@@ -48,4 +49,3 @@ Related Commands
4849

4950
config </command/atlas-kubernetes-config>
5051
operator </command/atlas-kubernetes-operator>
51-

0 commit comments

Comments
 (0)