Skip to content

Commit 18f9829

Browse files
authored
(DOCSP-22195) Create MEKO file system store tutorial (#1187)
* (DOCSP-22195) First draft of File Store tutorial. * (DOCSP-22195) Rendering corrections. * (DOCSP-22195) * (DOCSP-22195) Formatting correction. * (DOCSP-22195) * (DOCSP-22195) Formatting fix * (DOCSP-22195) * (DOCSP-22195) * (DOCSP-22195) * (DOCSP-22195) Copy review * (DOCSP-22195) Add link to Access Modes Kubernetes docs page. * (DOCSP-22195) Add keywords.
1 parent 8ffaf99 commit 18f9829

File tree

4 files changed

+178
-0
lines changed

4 files changed

+178
-0
lines changed
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
title: "Create a PersistentVolumeClaim object."
2+
stepnum: 1
3+
level: 4
4+
ref: filestore-create-pvc-object
5+
content: |
6+
7+
Create a :k8sdocs:`PersistentVolumeClaim </concepts/storage/persistent-volumes/>`
8+
object, and allocate storage as needed. Set
9+
:k8sdocs:`accessModes </concepts/storage/persistent-volumes/#access-modes>`
10+
to ``ReadWriteMany``:
11+
12+
.. code-block:: yaml
13+
14+
apiVersion: v1
15+
kind: PersistentVolumeClaim
16+
metadata:
17+
name: snapshot-store-ops-manager
18+
spec:
19+
storageClassName: managed-nfs-storage #SC that supports(RWX)
20+
accessModes:
21+
- ReadWriteMany
22+
resources:
23+
requests:
24+
storage: 10G
25+
...
26+
27+
---
28+
title: "Create and apply an Ops Manager Custom Resource Definition specifying your PersistentVolumeClaim."
29+
stepnum: 2
30+
level: 4
31+
ref: filestore-create-apply-crd
32+
content: |
33+
34+
Create an |onprem| |k8s-crd| that specifies your
35+
``PersistentVolumeClaim`` object and the ``backup.fileSystemStores``
36+
field, which is the name of your file system snapshot store.
37+
38+
The following example creates a |k8s-crd| file named
39+
``ops-manager-fs.yaml``, for the MongoDB
40+
:term:`oplog store <oplog store database>` with a ``kube-user``.
41+
42+
.. code-block:: yaml
43+
44+
apiVersion: mongodb.com/v1
45+
kind: MongoDBOpsManager
46+
metadata:
47+
name: ops-manager
48+
spec:
49+
replicas: 1
50+
version: 6.0.7
51+
adminCredentials: ops-manager-admin-secret
52+
statefulSet:
53+
spec:
54+
template:
55+
spec:
56+
volumes:
57+
- name: snapshot-store
58+
persistentVolumeClaim:
59+
claimName: snapshot-store-ops-manager
60+
containers:
61+
- name: mongodb-ops-manager
62+
volumeMounts:
63+
- name: snapshot-store
64+
mountPath: /snapshot_store
65+
backup:
66+
enabled: true
67+
fileSystemStores: filesystem1
68+
opLogStores:
69+
- name: oplog1
70+
mongodbResourceRef:
71+
name: oplog-db
72+
# mongodbUserRef:
73+
# name: kube-user
74+
statefulSet:
75+
spec:
76+
template:
77+
spec:
78+
volumes:
79+
- name: snapshot-store
80+
persistentVolumeClaim:
81+
claimName: snapshot-store-ops-manager
82+
containers:
83+
- name: mongodb-backup-daemon
84+
volumeMounts:
85+
- name: snapshot-store
86+
mountPath: /snapshot_store
87+
applicationDatabase:
88+
members: 3
89+
version: 5.0.7-ent
90+
91+
---
92+
title: "Apply changes to your |onprem| deployment."
93+
stepnum: 3
94+
level: 4
95+
ref: apply-changes-om-k8s
96+
content: |
97+
98+
Invoke the following ``kubectl`` command on the filename of your
99+
|onprem| resource definition:
100+
101+
.. code-block:: sh
102+
103+
kubectl apply -f <opsmgr-resource>.yaml
104+
105+
---
106+
title: "Configure your oplog store."
107+
stepnum: 4
108+
level: 4
109+
ref: filestore-config-oplog-store
110+
content: |
111+
112+
Wait for your |onprem| object to report its state as ``Running``, then
113+
configure your oplog store as described in the
114+
**Configure Backup Settings** step of the
115+
:ref:`Deploy an Ops Manager Resource <deploy-om-tls>` procedure.
116+
117+
---
118+
title: "Create a File System Snapshot Store in |onprem|."
119+
stepnum: 5
120+
level: 4
121+
ref: filestore-create-snapshot-store
122+
content: |
123+
124+
Log into your |onprem| instance and navigate to: :guilabel:`Admin`
125+
:icon-fa5:`arrow-right` :guilabel:`Backup` :icon-fa5:`arrow-right`
126+
:guilabel:`Snapshot Store` :icon-fa5:`arrow-right`
127+
:guilabel:`Create New File System Store`.
128+
129+
Set the name to the value you set for ``backup.fileSystemStores``
130+
in your |k8s-crd|. Set the other values as appropriate, then click
131+
:guilabel:`Create`.
132+
133+
Your |onprem| object will report a ``BACKUP`` state of ``Pending``
134+
after you create the new file system store.
135+
136+
...

source/om-resources.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,18 @@ Deploy and Configure Ops Manager Resources
3939
Configure queryable backups for |onprem| deployments created with the
4040
|k8s-op-short|.
4141

42+
:ref:`configure-file-store`
43+
Configure backup snapshot storage for |onprem| resources
44+
created with |k8s-op-short|.
45+
4246
:ref:`configure-kmip-backup-encryption`
4347
Configure |kmip| backup encryption.
4448

4549
:ref:`cert-manager-integration`
4650
Configure automated certificate renewal for |onprem| deployments with
4751
``cert-manager``.
4852

53+
4954
.. class:: hidden
5055

5156
.. toctree::
@@ -59,3 +64,4 @@ Deploy and Configure Ops Manager Resources
5964
/tutorial/configure-om-queryable-backups
6065
/tutorial/configure-kmip-backup-encryption
6166
/tutorial/cert-manager-integration
67+
/tutorial/configure-file-store
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _configure-file-store:
2+
3+
======================================================
4+
Configure File System Backup Store with |k8s-op-short|
5+
======================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. meta::
10+
:keywords: backup
11+
:keywords: snapshot storage
12+
13+
.. contents:: On this page
14+
:local:
15+
:backlinks: none
16+
:depth: 1
17+
:class: singlecol
18+
19+
|k8s-op-short| supports storage of filesystem snapshots.
20+
21+
Prerequisites
22+
-------------
23+
24+
To configure file system snapshot storage, your |k8s-op-short|
25+
deployment must have a
26+
:k8sdocs:`storage class </concepts/storage/storage-classes/>`
27+
configured with the ``ReadWriteMany`` method.
28+
29+
Procedure
30+
---------
31+
32+
To configure file system snapshot storage:
33+
34+
.. include:: /includes/steps/configure-filesystem-store.rst

source/tutorial/deploy-om-container.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ your |onprem| and application database connections with |tls|.
4848
.. tab:: TLS-Encrypted Connections (HTTPS)
4949
:tabid: https
5050

51+
.. _deploy-om-tls:
52+
5153
Prerequisites
5254
-------------
5355

0 commit comments

Comments
 (0)