Skip to content

Commit 227f29e

Browse files
catch up changelog (#4)
1 parent 7e0018f commit 227f29e

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

source/ak8so-changelog.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,89 @@
1919
You can find the full list of |ak8so| releases `here
2020
<https://github.com/mongodb/mongodb-atlas-kubernetes/releases>`_.
2121

22+
.. _ak8so_201:
23+
24+
|ak8so| 2.0.1
25+
-------------
26+
27+
Breaking Changes
28+
~~~~~~~~~~~~~~~~
29+
30+
- Custom resources you delete in |k8s| won't get deleted in
31+
|service|. Instead, |ak8so| stops managing those resources.
32+
For example, if you delete an :ref:`atlasproject-custom-resource`
33+
in |k8s|, |ak8so| no longer automatically deletes the corresponding project
34+
from |service|, preventing accidental or unexpected deletions. To learn more,
35+
including how to :ref:`revert this behavior <revert-deletion-protection>` to
36+
the default prior to |ak8so| 2.0.1, see :ref:`deletion-protection`.
37+
38+
- ``deploymentSpec`` replaces ``advancedDeploymentSpec`` in
39+
the ``AtlasDeployment`` custom resource. You must update your ``AtlasDeployment``
40+
custom resource as follows:
41+
42+
- If you use ``advancedDeploymentSpec``, rename to ``deploymentSpec``.
43+
You don't need to change any formatting.
44+
45+
- If you used ``deploymentSpec`` prior to |ak8so| 2.0.1, rewrite your
46+
``AtlasDeployment`` custom resource to match the formatting used in
47+
:ref:`the examples <atlasdeployment-examples>`.
48+
49+
- Improves snapshot distribution management by removing ``replicationSpecId`` from
50+
the :ref:`atlasbackupschedule-custom-resource` so it can be reused by multiple
51+
deployments managed by |ak8so|. The ``replicationSpecId`` is now automatically
52+
set for every deployment that references it. As a result of this change, you
53+
can no longer configure ``replicationSpecId`` and should remove it from your
54+
``AtlasBackupSchedule`` custom resource.
55+
56+
- Forces the use of ``secretRef`` fields for ``encryptionAtRest`` and ``alertConfigurations``
57+
features to promote security best practices. You should now store API
58+
secrets and credentials as |k8s-secrets| and reference
59+
them from the :ref:`atlasproject-custom-resource` using the following fields:
60+
61+
For :setting:`spec.alertConfigurations.notifications`:
62+
63+
- Use ``APITokenRef`` instead of ``APIToken``
64+
- Use ``DatadogAPIKeyRef`` instead of ``DatadogAPIKey``
65+
- Use ``FlowdockTokenAPIRef`` instead of ``FlowdockTokenAPI``
66+
- Use ``OpsGenieAPIKeyRef`` instead of ``OpsGenieAPIKey``
67+
- Use ``VictorOpsSecretRef`` instead of ``VictorOpsAPIKey`` and ``VictorOpsRoutingKey``
68+
69+
70+
To learn more, see :ref:`ak8so-tp-ac-example`.
71+
72+
For :setting:`spec.encryptionAtRest`:
73+
74+
- **AWS** Use ``secretRef`` instead of ``AccessKeyID``, ``SecretAccessKey``,
75+
``CustomerMasterKeyID``, and ``RoleID``.
76+
77+
- **Azure** Use ``secretRef`` instead of ``SubscriptionID``, ``KeyVaultName``,
78+
``KeyIdentifier``, and ``Secret``.
79+
80+
- **GCP** Use ``secretRef`` instead of ``ServiceAccountKey`` or ``KeyVersionResourceID``.
81+
82+
To learn more, see :ref:`<ak8so-ear>`.
83+
84+
.. _ak8so_200:
85+
86+
|ak8so| 2.0.0
87+
-------------
88+
89+
.. warning::
90+
91+
This release contains an issue that prevents |ak8so| from reconciling the
92+
:ref:`atlasbackupschedule-custom-resource` when :ref:`deletion protection <deletion-protection>` is enabled.
93+
Don't use this version (2.0.0), and instead use |ak8so| 2.0.1.
94+
95+
.. _ak8so_191:
96+
97+
|ak8so| 1.9.1
98+
-------------
99+
100+
Fixes
101+
~~~~~
102+
103+
- Fixes missing permissions for the :ref:`atlasfederatedauth-custom-resource`.
104+
22105
.. _ak8so_190:
23106

24107
|ak8so| 1.9.0

0 commit comments

Comments
 (0)