Skip to content

Commit 27c64ed

Browse files
DOCSP-40961 -- Add more CRD metadata for better client user experience (#117)
* DOCSP-40961 -- add short names; add kubectl command updates * Update source/custom-resources.txt Co-authored-by: Evelyn Rabil <[email protected]> --------- Co-authored-by: Evelyn Rabil <[email protected]>
1 parent 0e833d8 commit 27c64ed

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

source/custom-resources.txt

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,50 +16,79 @@ Custom Resources
1616

1717
.. list-table::
1818
:header-rows: 1
19-
:widths: 30 70
19+
:widths: 30 60 10
2020

2121
* - Resource
2222
- Description
23+
- Short Name
2324

2425
* - :ref:`atlasbackuppolicy-custom-resource`
2526
- Backup policy to back up your {+cluster+}
2627
|service|.
28+
- abp
2729

2830
* - :ref:`atlasbackupschedule-custom-resource`
2931
- Backup schedule to back up your {+cluster+}
3032
|service|.
33+
- abs
3134

3235
* - :ref:`atlasdeployment-custom-resource`
3336
- {+Cluster+} inside some project in |service|.
37+
- ad
3438

3539
* - :ref:`atlasdatabaseuser-custom-resource`
3640
- Database user inside some project in
3741
|service|.
42+
- adu
3843

3944
* - :ref:`atlasproject-custom-resource`
4045
- Project in |service|.
46+
- ap
4147

4248
* - :ref:`atlasteam-custom-resource`
4349
- Project team in |service|.
50+
- at
4451

4552
* - :ref:`atlasdatafederation-custom-resource`
4653
- {+fdi+} and its private endpoints in
4754
|service|.
55+
- adf
4856

4957
* - :ref:`atlassearchindexconfig-custom-resource`
5058
- Index for some collection in your |service| {+cluster+}.
59+
- asic
5160

5261
* - :ref:`atlasstreamconnection-custom-resource`
5362
- {+atlas-sp+} connection.
63+
- asc
5464

5565
* - :ref:`atlasstreaminstance-custom-resource`
5666
- {+atlas-sp+} instance.
67+
- asi
5768

5869
* - :ref:`atlasfederatedauth-custom-resource`
5970
- Federated authentication in |service|.
71+
- afa
6072

6173
.. include:: /includes/fact-ak8so-crds.rst
6274

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+
6392
|ak8so| Workflow
6493
----------------
6594

0 commit comments

Comments
 (0)