Skip to content

Commit a7c52af

Browse files
DOCSP-43762 -- Explicitly define config details in CR (#154)
* DOCSP-43762 -- Explicitly define config details in CR * DOCSP-43762 -- External review revisions * DOCSP-43762 -- External review revisions
1 parent aa1cdc0 commit a7c52af

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

source/includes/fact-ak8so-crds.rst

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,35 @@
11
.. important:: Custom Resources No Longer Delete Objects by Default
22

3-
|ak8so| uses :ref:`custom resource <custom-resources>` configuration
4-
files to manage your |service| configuration, but as of |ak8so| 2.0,
5-
custom resources you delete in |k8s| are no longer deleted in
6-
|service|. Instead, |ak8so| simply stops managing those resources.
7-
For example, if you delete an :ref:`atlasproject-custom-resource`
8-
in |k8s|, |ak8so| no longer automatically deletes the corresponding project
9-
from |service|, preventing accidental or unexpected deletions. To learn more,
10-
including how to :ref:`revert this behavior <revert-deletion-protection>` to
11-
the default used prior to |ak8so| 2.0, see :ref:`deletion-protection`.
12-
13-
Similarly, |ak8so| does not delete teams from |service| if you remove them from an
14-
|service| project in |k8s| with the |ak8so|.
3+
* |ak8so| uses :ref:`custom resource <custom-resources>` configuration
4+
files to manage your |service| configuration, but as of |ak8so| 2.0,
5+
custom resources you delete in |k8s| are no longer (by default) deleted in
6+
|service|. Instead, |ak8so| simply stops managing those resources in |service|.
7+
For example, if you delete an :ref:`atlasproject-custom-resource`
8+
in |k8s|, by default the |ak8so| no longer automatically deletes the
9+
corresponding project from |service|. This change in behavior is intended
10+
to help prevent accidental or unexpected deletions. To learn more,
11+
including how to :ref:`revert this behavior <revert-deletion-protection>`
12+
to the default used prior to |ak8so| 2.0, see :ref:`deletion-protection`.
13+
14+
Similarly, |ak8so| does not delete teams from |service| if you remove them from an
15+
|service| project in |k8s| with the |ak8so|.
16+
17+
* Explicitly define your desired configuration details in order to avoid implicitly
18+
using default |service| configuration values. In some cases, inheriting |service|
19+
defaults may result in a reconciliation loop which can prevent your
20+
custom resource from achieving a ``READY`` state. For example,
21+
explicitly defining your desired autoscaling behavior in your ``AtlasDeployment``
22+
custom resource, as shown in the included example, ensures that
23+
a static instance size in your custom resource is not being repeatedly
24+
applied to an |service| deployment which has autoscaling enabled.
25+
26+
.. code-block:: yaml
27+
28+
autoScaling:
29+
diskGB:
30+
enabled: true
31+
compute:
32+
enabled: true
33+
scaleDownEnabled: true
34+
minInstanceSize: M30
35+
maxInstanceSize: M40

0 commit comments

Comments
 (0)