@@ -16,50 +16,79 @@ Custom Resources
16
16
17
17
.. list-table::
18
18
:header-rows: 1
19
- :widths: 30 70
19
+ :widths: 30 60 10
20
20
21
21
* - Resource
22
22
- Description
23
+ - Short Name
23
24
24
25
* - :ref:`atlasbackuppolicy-custom-resource`
25
26
- Backup policy to back up your {+cluster+}
26
27
|service|.
28
+ - abp
27
29
28
30
* - :ref:`atlasbackupschedule-custom-resource`
29
31
- Backup schedule to back up your {+cluster+}
30
32
|service|.
33
+ - abs
31
34
32
35
* - :ref:`atlasdeployment-custom-resource`
33
36
- {+Cluster+} inside some project in |service|.
37
+ - ad
34
38
35
39
* - :ref:`atlasdatabaseuser-custom-resource`
36
40
- Database user inside some project in
37
41
|service|.
42
+ - adu
38
43
39
44
* - :ref:`atlasproject-custom-resource`
40
45
- Project in |service|.
46
+ - ap
41
47
42
48
* - :ref:`atlasteam-custom-resource`
43
49
- Project team in |service|.
50
+ - at
44
51
45
52
* - :ref:`atlasdatafederation-custom-resource`
46
53
- {+fdi+} and its private endpoints in
47
54
|service|.
55
+ - adf
48
56
49
57
* - :ref:`atlassearchindexconfig-custom-resource`
50
58
- Index for some collection in your |service| {+cluster+}.
59
+ - asic
51
60
52
61
* - :ref:`atlasstreamconnection-custom-resource`
53
62
- {+atlas-sp+} connection.
63
+ - asc
54
64
55
65
* - :ref:`atlasstreaminstance-custom-resource`
56
66
- {+atlas-sp+} instance.
67
+ - asi
57
68
58
69
* - :ref:`atlasfederatedauth-custom-resource`
59
70
- Federated authentication in |service|.
71
+ - afa
60
72
61
73
.. include:: /includes/fact-ak8so-crds.rst
62
74
75
+ Managing |ak8so| with ``kubectl``
76
+ -----------------------------------
77
+
78
+ To list all |ak8so| resources in your cluster with ``kubectl``, you can run:
79
+
80
+ .. code-block:: sh
81
+
82
+ kubectl get atlas
83
+
84
+ For your convenience, to list or describe specific types of |ak8so| CRDs,
85
+ you can use the short names listed in the above table. For example, to list all
86
+ ``atlasdatabaseusers`` in the ``mongodb`` namespace, you can run:
87
+
88
+ .. code-block:: sh
89
+
90
+ kubectl get adu -n mongodb
91
+
63
92
|ak8so| Workflow
64
93
----------------
65
94
0 commit comments