Skip to content

Commit cc9b4ce

Browse files
jwilliams-mongojwilliams-mongo
committed
add files from cloud-docs
1 parent a209d4d commit cc9b4ce

File tree

135 files changed

+16771
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+16771
-0
lines changed

‎.gitignore

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.DS_Store
2+
build/*
3+
*.swp
4+
.#*
5+
\#*#
6+
*.pyc
7+
*.pyo
8+
fabfile
9+
docs_meta.yaml
10+
meta.yaml
11+
source/includes/table-*rst
12+
source/includes/hash.rst
13+
source/includes/toc-*rst
14+
source/includes/dfn-*rst
15+
source/includes/table-*rst
16+
source/includes/toc/
17+
source/includes/table/
18+
source/includes/steps/
19+
handouts/build
20+
handouts/logo.png
21+
handouts/mongodb-logo.eps
22+
handouts/mongodb-logo-eps-converted-to.pdf
23+
source/figures/
24+
giza.log
25+
backups/*
26+
.vscode/

‎config/redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
define: base https://www.mongodb.com/docs/atlas/atlas-operator

‎snooty.toml

Lines changed: 327 additions & 0 deletions
Large diffs are not rendered by default.

‎source/ak8so-alert-configurations.txt

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
.. _ak8so-alert-configurations:
2+
3+
========================
4+
Configure Project Alerts
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+
You can use |ak8so| to configure alerts to help
16+
you monitor access to and the state of the
17+
{+database-deployments+} in your |service| projects.
18+
19+
To learn more, see :ref:`configure-alerts`.
20+
21+
22+
.. _ak8so-ac-considerations:
23+
24+
Considerations
25+
--------------
26+
27+
In your :ref:`atlasproject-custom-resource`, use the
28+
:setting:`spec.alertConfigurationSyncEnabled` and
29+
:setting:`spec.withDefaultAlertsSettings` settings to
30+
manage |service| alert configurations. The following
31+
table describes the action that |ak8so| takes based on
32+
how you configure these settings:
33+
34+
.. list-table::
35+
:header-rows: 1
36+
37+
* - spec.alertConfigurationSyncEnabled
38+
- spec.withDefaultAlertsSettings
39+
- Behavior
40+
41+
* - **true**
42+
- **true**
43+
- |ak8so| creates a project using the default alert configuration.
44+
After |ak8so| creates the project, the alert confgurations that
45+
you define in your :ref:`atlasproject-custom-resource` override
46+
the alert configurations on |service| for your project.
47+
48+
* - **true**
49+
- **false**
50+
- |ak8so| creates a project without adding the default alert configurations.
51+
After |ak8so| creates the project, the alert confgurations that
52+
you define in your :ref:`atlasproject-custom-resource` override
53+
the alert configurations on |service| for your project.
54+
55+
* - **false**
56+
- **true**
57+
- |ak8so| creates a project using the default alert configuration.
58+
|ak8so| doesn't syncronize alert definitions on |service| with those
59+
you define in your :ref:`atlasproject-custom-resource`.
60+
61+
* - **false**
62+
- **false**
63+
- |ak8so| creates a project without adding the default alert configurations.
64+
|ak8so| doesn't syncronize alert definitions on |service| with those
65+
you define in your :ref:`atlasproject-custom-resource`.
66+
67+
Prerequisites
68+
-------------
69+
70+
.. include:: /includes/fact-ak8so-api-key-permission.rst
71+
72+
To learn more, see :ref:`ak8so-access-to-atlas-ref`.
73+
74+
Procedure
75+
---------
76+
77+
To configure project alerts, configure the
78+
:ref:`atlasproject-custom-resource`.
79+
80+
**Example:**
81+
82+
.. code-block:: sh
83+
84+
cat <<EOF | kubectl apply -f -
85+
apiVersion: atlas.mongodb.com/v1
86+
kind: AtlasProject
87+
metadata:
88+
name: my-project
89+
labels:
90+
app.kubernetes.io/version: 1.6.0
91+
spec:
92+
name: TestAlertConfig
93+
connectionSecretRef:
94+
name: my-atlas-key
95+
projectIpAccessList:
96+
- ipAddress: "0.0.0.0/1"
97+
comment: "Everyone has access. For test purposes only."
98+
- ipAddress: "128.0.0.0/1"
99+
comment: "Everyone has access. For test purposes only."
100+
alertConfigurations:
101+
- eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
102+
enabled: true,
103+
notifications:
104+
- delayMin: 0
105+
emailEnabled: true
106+
intervalMin: 60
107+
roles: [ "GROUP_OWNER" ]
108+
smsEnabled: false
109+
typeName: "GROUP"
110+
threshold:
111+
operator: "LESS_THAN",
112+
threshold: 1,
113+
units: "HOURS"
114+
alertConfigurationSyncEnabled: true
115+
withDefaultAlertsSettings: false
116+
EOF
117+
118+
The parameters that you must specify in the
119+
:ref:`atlasproject-custom-resource` depend on the alert
120+
that you want to configure.
121+
122+
To learn more about the configuration parameters available from
123+
the |api|, see :oas-atlas-op:`Alert Configurations
124+
</Alert-Configurations>`.

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

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
.. _ak8so-backup:
2+
3+
==================================
4+
Back Up Your |service| {+Cluster+}
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
.. include:: /includes/fact-atlas-free-tier-limits.rst
16+
17+
.. note:: {+Serverless-instances+} back up automatically
18+
19+
|service| automatically enables backups for {+serverless-instances+}
20+
and takes snapshots every six hours. Any |ak8so| backup custom
21+
resources you apply to a {+serverless-instance+} will not override
22+
the automatic settings.
23+
24+
To learn more about backups for {+serverless-instances+}, see
25+
:ref:`serverless-snapshots`.
26+
27+
|ak8so| supports :ref:`{+cloud-backup+} <backup-cloud-provider>` for
28+
your |service| {+clusters+}. {+Cloud-backup+} uses the native
29+
snapshot capabilities of your cloud provider to support full-copy
30+
snapshots and localized snapshot storage.
31+
32+
To manage {+cloud-backup+} with |ak8so|, you can specify and
33+
update the following custom resources:
34+
35+
.. list-table::
36+
:widths: 50 80
37+
:header-rows: 1
38+
39+
* - Custom Resource
40+
- Purpose
41+
42+
* - :ref:`atlasbackuppolicy-custom-resource`
43+
- Defines the backup policy, including the frequency of backups
44+
and the length of snapshot retention.
45+
46+
* - :ref:`atlasbackupschedule-custom-resource`
47+
- Defines the backup schedule, including the time of day that
48+
|service| backs up your {+database-deployment+}, the number
49+
of days back in time to which you can restore, and the backup policy.
50+
51+
* - :ref:`atlasdeployment-custom-resource`
52+
- Defines the characteristics of a {+cluster+}. You
53+
must set the :setting:`spec.backupRef.name` field to the name of
54+
the configured backup schedule to enable {+cloud-backup+} for
55+
the {+cluster+}.
56+
57+
Additionally, to configure continuous backup, you must set :setting:`spec.deploymentSpec.pitEnabled` to ``true``.
58+
59+
Each time you change any of the supported custom resources, |ak8so|
60+
:ref:`creates or updates <ak8so-create-update-process>` the
61+
corresponding |service| configuration.
62+
63+
Considerations
64+
--------------
65+
66+
Review the following considerations:
67+
68+
- You can specify one backup policy per backup schedule.
69+
- You can specify one backup schedule per {+cluster+}, but
70+
you can use the same backup schedule for multiple
71+
{+clusters+}.
72+
- |service| determines the order of nodes to snapshot based on your
73+
{+cluster+} configuration. To learn more, see
74+
:ref:`Cloud Backups <single-region-cloud-backup>`.
75+
- |ak8so| supports automatic :ref:`snapshot distribution <snapshot-distribution>`.
76+
You can configure this with the ``spec.copySetting`` field in the
77+
:ref:`atlasbackupschedule-custom-resource`.
78+
79+
Limitations
80+
-----------
81+
82+
Certain limitations apply to {+cloud-backup+}. To learn more, see
83+
:ref:`<backup-cloud-provider>`.
84+
85+
Prerequisites
86+
-------------
87+
88+
To enable {+cloud-backup+} for your |ak8so|-managed
89+
{+cluster+}, you must:
90+
91+
- Have a running |k8s| cluster with
92+
|ak8so| :ref:`deployed <ak8so-quick-start-ref>`.
93+
- Ensure your |ipaddr| address is in the organization's |api|
94+
:ref:`access list <access-list>`.
95+
96+
.. _ak8so-configure-backup:
97+
98+
Procedure
99+
---------
100+
101+
Follow these steps to enable {+cloud-backup+} for your |ak8so|-managed
102+
{+clusters+}:
103+
104+
.. procedure::
105+
:style: normal
106+
107+
.. step:: Create the backup policy.
108+
109+
To learn more about the parameters for a backup policy, see
110+
:ref:`atlasbackuppolicy-custom-resource`.
111+
112+
**Example:**
113+
114+
.. code-block:: sh
115+
116+
cat <<EOF | kubectl apply -f -
117+
apiVersion: atlas.mongodb.com/v1
118+
kind: AtlasBackupPolicy
119+
metadata:
120+
name: "atlas-default-backuppolicy"
121+
labels:
122+
app.kubernetes.io/version: 1.6.0
123+
spec:
124+
items:
125+
frequencyType: "weekly"
126+
frequencyInterval: 1
127+
retentionUnit: "days"
128+
retentionValue: 7
129+
EOF
130+
131+
.. step:: Create the backup schedule.
132+
133+
In the :setting:`spec.policy.name` field, specify the
134+
``metadata.name`` from the
135+
:ref:`atlasbackuppolicy-custom-resource` to apply your backup
136+
policy.
137+
138+
To learn more about the other parameters for a backup schedule
139+
see :ref:`atlasbackupschedule-custom-resource`.
140+
141+
**Example:**
142+
143+
.. code-block:: sh
144+
145+
cat <<EOF | kubectl apply -f -
146+
apiVersion: atlas.mongodb.com/v1
147+
kind: AtlasBackupSchedule
148+
metadata:
149+
name: "atlas-default-backupschedule"
150+
labels:
151+
app.kubernetes.io/version: 1.6.0
152+
spec:
153+
autoExportEnabled: true
154+
copySettings:
155+
- cloudProvider: AWS
156+
frequencies:
157+
- HOURLY
158+
regionName: US_EAST_1
159+
replicationSpecId: "string"
160+
shouldCopyOplogs: true
161+
referenceHourOfDay: 10
162+
referenceMinuteOfHour: 10
163+
restoreWindowDays: 2
164+
policy:
165+
name: atlas-default-backuppolicy
166+
namespace: mongodb-atlas-system
167+
EOF
168+
169+
.. step:: Apply the backup schedule to the {+cluster+}.
170+
171+
In the :setting:`spec.backupRef.name` field of the
172+
:ref:`atlasdeployment-custom-resource`, specify the
173+
``metadata.name`` from the
174+
:ref:`atlasbackupschedule-custom-resource` to apply your
175+
backup schedule to the {+cluster+}.
176+
177+
**Example:**
178+
179+
.. code-block:: sh
180+
181+
cat <<EOF | kubectl apply -f -
182+
apiVersion: atlas.mongodb.com/v1
183+
kind: AtlasDeployment
184+
metadata:
185+
name: my-atlas-cluster
186+
labels:
187+
app.kubernetes.io/version: 1.6.0
188+
spec:
189+
backupRef:
190+
name: atlas-default-backupschedule
191+
namespace: mongodb-atlas-system
192+
EOF
193+

0 commit comments

Comments
 (0)