Skip to content

Commit 214060d

Browse files
corryrootcorryroot
authored
(DOCSP-35342): Added AKO BCP content. (#14)
* (DOCSP-35342): Added AKO BCP content. * (DOCSP-35342): Incorporated Roo and Dan's feedback. * (DOCSP-35342): Incorporated Serguisz's feedback. * (DOCSP-35342): Incorporated Evelyn's feedback. * (DOCSP-35342): Incorporated Roo's feedback. * (DOCSP-35342): Incorporated Roo's feedback. * (DOCSP-35342): Added shortcut.
1 parent 27c64ed commit 214060d

7 files changed

+572
-1
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ intersphinx = [ "https://www.mongodb.com/docs/master/objects.inv",
1616
toc_landing_pages = [
1717
"/configure-ak8so-access-to-atlas",
1818
"/custom-resources",
19-
"/ak8so-private-link"
19+
"/ak8so-private-link",
20+
"/ak8so-back-up-deployment"
2021
]
2122

2223
[constants]

‎source/ak8so-back-up-deployment.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,24 @@ Review the following considerations:
7676
You can configure this with the ``spec.copySetting`` field in the
7777
:ref:`atlasbackupschedule-custom-resource`.
7878

79+
.. note::
80+
81+
If you have a :ref:`{+bcp+} enabled <ak8so-bcp>`, you
82+
can't modify the :ref:`backup policy <configure-backup-policy>` for
83+
an individual {+cluster+} below the minimum requirements set in the
84+
{+bcp+}. You can modify the {+cluster+}-level backup policy at any
85+
time. |service| augments any preexisting {+cluster+}-level policies
86+
to meet the minimum requirements of the {+bcp+}. All new
87+
{+clusters+} use the {+bcp+}. If you reduce the frequency of a
88+
backup schedule, the change applies only to future backups. Any
89+
existing :term:`oplog` remains for the original window. The minimum
90+
requirements of the {+bcp+} apply. You can
91+
:ref:`configure extra snapshot retention
92+
<config-extra-snapshot-retention>`. You can also view backup details
93+
for all ``M10+`` {+dedicated-clusters+} including deleted
94+
{+clusters+} with retained snapshots. To learn more, see
95+
:ref:`backup-retained-snapshots`.
96+
7997
Limitations
8098
-----------
8199

@@ -184,3 +202,8 @@ Follow these steps to enable {+cloud-backup+} for your |ak8so|-managed
184202
namespace: mongodb-atlas-system
185203
EOF
186204

205+
.. toctree::
206+
:titlesonly:
207+
208+
Backup Compliance Policies </ak8so-bcp>
209+

‎source/ak8so-bcp.txt

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
.. _ak8so-bcp:
2+
3+
====================================
4+
Configure a {+bcp+}
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+
If you have strict data protection requirements, you can use |ak8so| to
16+
enable a :ref:`{+bcp+} <backup-compliance-policy>` to protect your
17+
backup data.
18+
19+
.. include:: /includes/fact-you-cannot-disable-bcp.rst
20+
21+
.. _ak8so-bcp-prohibited-actions:
22+
23+
Prohibited Actions
24+
------------------
25+
26+
If you enable a {+bcp+}, no user, regardless of role, can do certain
27+
actions. Carefully review the :ref:`prohibited actions
28+
<bcp-prohibited-actions>`.
29+
30+
.. important::
31+
32+
If you set this parameter to ``true``, |service| upgrades all
33+
backup policies in the project regardless of what is specified in
34+
the :ref:`atlasbackuppolicy-custom-resource`. |service| overrides
35+
the :ref:`atlasbackuppolicy-custom-resource` and the status
36+
of that custom resource updates to ``Ready: False``. You must
37+
manually update the :ref:`atlasbackuppolicy-custom-resource` to
38+
align with the {+bcp+}.
39+
40+
If you set this parameter to ``false``, creating the {+bcp+} fails
41+
if the existing backup policies do not satisfy the {+bcp+}.
42+
43+
.. _ak8so-bcp-considerations:
44+
45+
Considerations
46+
--------------
47+
48+
After you enable a {+bcp+}, certain behaviors apply. Carefully
49+
review the :ref:`considerations <bcp-considerations>`.
50+
51+
Required Access
52+
---------------
53+
54+
To configure a {+bcp+}, you must have :authrole:`Project Owner` access
55+
to the project. Users with :authrole:`Organization Owner` access must
56+
add themselves as a ``Project Owner`` to the project before configuring
57+
a {+bcp+}.
58+
59+
Prerequisites
60+
-------------
61+
62+
- Only MongoDB Support can do the following actions:
63+
64+
- Disable the {+bcp+}.
65+
66+
- Disable :ref:`{+PIT-Restore+} <create-cluster-backups>` if the
67+
{+bcp+} has the
68+
:guilabel:`Require Point in Time Restore to all clusters` option
69+
set to :guilabel:`On`.
70+
71+
- Reduce the :ref:`{+PIT-Restore+} Restore Window
72+
<create-pit-policy>`.
73+
74+
- Delete :ref:`policy items <creating-backup-policy>` specified in
75+
the {+bcp+}.
76+
77+
- Only the specified security or legal representative can
78+
:ref:`request support <request-support>`.
79+
80+
- You can apply a {+bcp+} to ``M10+`` {+dedicated-clusters+} only.
81+
82+
.. note::
83+
84+
You can't convert a {+dedicated-cluster+} to an ``M0``
85+
{+free-cluster+}, an ``M2`` or ``M5`` {+shared-cluster+}, or a
86+
{+serverless-instance+}.
87+
88+
Procedure
89+
---------
90+
91+
.. procedure::
92+
:style: normal
93+
94+
.. step:: Create the {+bcp+}.
95+
96+
To learn more about the parameters for a {+bcp+}, see the
97+
:ref:`bcp-custom-resource`.
98+
99+
**Example:**
100+
101+
.. code-block:: sh
102+
103+
cat <<EOF | kubectl apply -f -
104+
apiVersion: atlas.mongodb.com/v1
105+
kind: AtlasBackupCompliancePolicy
106+
metadata:
107+
name: my-backup-compliance-policy
108+
namespace: mongdb-atlas-system
109+
spec:
110+
authorizedEmail: [email protected]
111+
authorizedUserFirstName: John
112+
authorizedUserLastName: Doe
113+
copyProtectionEnabled: false
114+
encryptionAtRestEnabled: false
115+
onDemandPolicy:
116+
retentionUnit: weeks
117+
retentionValue: 3
118+
overwriteBackupPolicies: false
119+
pointInTimeEnabled: true
120+
restoreWindowDays: 42
121+
scheduledPolicyItems:
122+
- frequencyInterval: 2
123+
frequencyType: daily
124+
retentionUnit: days
125+
retentionValue: 7
126+
EOF
127+
128+
.. note::
129+
130+
This {+bcp+} applies as the minimum backup policy to all
131+
{+clusters+} in the project. The {+bcp+} protects all
132+
existing snapshots. The {+bcp+} prevents any user,
133+
regardless of role, from modifying or deleting existing
134+
snapshots prior to their expiration. Changes made to this
135+
{+bcp+} apply only to future snapshots. If you enable a
136+
{+bcp+}, the {+bcp+} limits your ability to reduce backup
137+
storage costs. You can't adjust the retention or delete a
138+
backup to reduce the backup storage costs.
139+
140+
.. step:: Apply the {+bcp+} to the project.
141+
142+
In the :setting:`spec.backupCompliancePolicyRef` parameter in the
143+
:ref:`atlasproject-custom-resource`, specify the name and
144+
namespace of the opaque |k8s-secret| that references the
145+
:ref:`bcp-custom-resource`.
146+
147+
**Example:**
148+
149+
.. code-block:: sh
150+
151+
cat <<EOF | kubectl apply -f -
152+
apiVersion: atlas.mongodb.com/v1
153+
kind: AtlasProject
154+
metadata:
155+
name: my-project
156+
spec:
157+
backupCompliancePolicyRef:
158+
name: my-backup-compliance-policy
159+
namespace: mongodb-atlas-system
160+
EOF
161+

‎source/atlasproject-custom-resource.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1109,6 +1109,35 @@ This section describes the ``AtlasProject`` custom resource parameters:
11091109
must specify this setting. To learn more, see
11101110
:ref:`enable-audit-logs`.
11111111

1112+
.. setting:: spec.backupCompliancePolicyRef
1113+
1114+
*Type*: object
1115+
1116+
*Conditional*
1117+
1118+
Object that contains the name and namespace of the opaque
1119+
|k8s-secret| that references the :ref:`bcp-custom-resource`. If you
1120+
enable a {+bcp+}, you must specify this parameter.
1121+
1122+
.. setting:: spec.backupCompliancePolicyRef.name
1123+
1124+
*Type*: string
1125+
1126+
*Conditional*
1127+
1128+
Name of the opaque |k8s-secret| that references the
1129+
:ref:`bcp-custom-resource`. If you enable a {+bcp+}, you must
1130+
specify this parameter.
1131+
1132+
.. setting:: spec.backupCompliancePolicyRef.namespace
1133+
1134+
*Type*: object
1135+
1136+
*Conditional*
1137+
1138+
Namespace of the opaque |k8s-secret| that references the
1139+
:ref:`bcp-custom-resource`. If you enable a {+bcp+}, you must
1140+
specify this parameter.
11121141

11131142
.. setting:: spec.connectionSecretRef.name
11141143

0 commit comments

Comments
 (0)