You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Summary
Fix broken links after merging
#463. This was
reported in
#463 (comment)
## Proof of Work
Links are properly referencing existing files.
## Checklist
- [x] Have you linked a jira ticket and/or is the ticket in the title?
- [x] Have you checked whether your jira ticket required DOCSP changes?
- [x] Have you added changelog file?
- use `skip-changelog` label if not needed
- refer to [Changelog files and Release
Notes](https://github.com/mongodb/mongodb-kubernetes/blob/master/CONTRIBUTING.md#changelog-files-and-release-notes)
section in CONTRIBUTING.md for more details
Copy file name to clipboardExpand all lines: docs/mongodbcommunity/deploy-configure.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,17 +17,17 @@ The [`/config/samples`](../config/samples) directory contains example MongoDBCom
17
17
## Deploy a Replica Set
18
18
19
19
**Warning:** When you delete MongoDB resources, persistent volumes remain
20
-
to help ensure that no unintended data loss occurs. If you create a new
21
-
MongoDB resource with the same name and persistent volumes, the
20
+
to help ensure that no unintended data loss occurs. If you create a new
21
+
MongoDB resource with the same name and persistent volumes, the
22
22
pre-existing data might cause issues if the new MongoDB resources have a
23
23
different topology than the previous ones.
24
24
25
25
To deploy your first replica set:
26
26
27
-
1. Replace `<your-password-here>` in [mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml) to the password you wish to use.
27
+
1. Replace `<your-password-here>` in [public/samples/community/mongodb.com_v1_mongodbcommunity_cr.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/mongodb.com_v1_mongodbcommunity_cr.yaml) to the password you wish to use.
3. Verify that the MongoDBCommunity resource deployed:
33
33
```
@@ -258,7 +258,7 @@ To upgrade this resource from `4.0.6` to `4.2.7`:
258
258
259
259
To deploy the operator on OpenShift you will have to provide the environment variable `MANAGED_SECURITY_CONTEXT` set to `true` for the operator deployment.
260
260
261
-
See [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
261
+
See [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
262
262
an example of how to provide the required configuration for a MongoDB
263
263
replica set.
264
264
@@ -344,7 +344,7 @@ Under some circumstances it might be necessary to set your own custom values for
344
344
the `ReadinessProbe` used by the MongoDB Community Operator. To do so, you
345
345
should use the `statefulSet` attribute in `resource.spec`, as in the following
Edit the file [cert-manager-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/cert-manager-certificate.yaml) to replace ```<mongodb-name>``` with your MongoDB deployment name. Also replace ```<domain-rs-1>```, ```<domain-rs-2>```, and ```<domain-rs-3>``` with the external FQDNs of the MongoDB replicaset members. Please remember that you will have to add an equal number of entries for each member of the replicaset, for example:
40
+
Edit the file [cert-manager-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/external_access/cert-manager-certificate.yaml) to replace ```<mongodb-name>``` with your MongoDB deployment name. Also replace ```<domain-rs-1>```, ```<domain-rs-2>```, and ```<domain-rs-3>``` with the external FQDNs of the MongoDB replicaset members. Please remember that you will have to add an equal number of entries for each member of the replicaset, for example:
41
41
42
42
```yaml
43
43
...
@@ -57,30 +57,30 @@ spec:
57
57
Apply the manifests. Replace ```<your-namespace>``` with the namespace you are using for the deployment.
Edit [mongodb.com_v1_mongodbcommunity_cr.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml). Replace <mongodb-name> with the desired MongoDB deployment name -- this should be the same as in the previous step. Replace ```<domain-rs-1>```, ```<domain-rs-2>```, and ```<domain-rs-3>``` with the external FQDNs of the MongoDB replicaset members. Please remember that you should have the same number of entries in this section as the number of your replicaset members. You can also edit the ports for external access to your preferred numbers in this section -- you will have to remember to change them in the next step too. Change ```<your-admin-password>``` to your desired admin password for MongoDB.
66
+
Edit [mongodb.com_v1_mongodbcommunity_cr.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml). Replace <mongodb-name> with the desired MongoDB deployment name -- this should be the same as in the previous step. Replace ```<domain-rs-1>```, ```<domain-rs-2>```, and ```<domain-rs-3>``` with the external FQDNs of the MongoDB replicaset members. Please remember that you should have the same number of entries in this section as the number of your replicaset members. You can also edit the ports for external access to your preferred numbers in this section -- you will have to remember to change them in the next step too. Change ```<your-admin-password>``` to your desired admin password for MongoDB.
### Create the external NodePort services for accessing the MongoDB deployment from outside the Kubernetes cluster
77
77
78
-
Edit [external_services.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/external_services.yaml) and replace ```<mongodb-name>``` with the MongoDB deployment name that you have used in the preceeding steps. You can change the ```nodePort``` and ```port``` to reflect the changes (if any) you have made in the previous steps.
78
+
Edit [external_services.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/external_access/external_services.yaml) and replace ```<mongodb-name>``` with the MongoDB deployment name that you have used in the preceeding steps. You can change the ```nodePort``` and ```port``` to reflect the changes (if any) you have made in the previous steps.
You can use Helm to install and deploy the MongoDB Community Kubernetes
26
-
Operator with X.509 Authentication enabled for the MongoDB Agent and
25
+
You can use Helm to install and deploy the MongoDB Community Kubernetes
26
+
Operator with X.509 Authentication enabled for the MongoDB Agent and
27
27
client. To learn more, see [Install the Operator using Helm](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/install-upgrade.md#install-the-operator-using-helm).
28
28
29
-
1. To deploy the MongoDB Community Kubernetes Operator, copy and paste
30
-
the following command and replace the `<namespace>` variable with the
29
+
1. To deploy the MongoDB Community Kubernetes Operator, copy and paste
30
+
the following command and replace the `<namespace>` variable with the
31
31
namespace:
32
32
33
33
**Note:**
34
34
35
35
The following command deploys a sample resource with X.509 enabled
36
36
for both the MongoDB Agent and client authentication. It also creates
37
-
a sample X.509 user and the certificate that the user can use to
37
+
a sample X.509 user and the certificate that the user can use to
38
38
authenticate.
39
39
40
40
```
@@ -47,81 +47,81 @@ client. To learn more, see [Install the Operator using Helm](https://github.com/
47
47
48
48
## Use `kubectl` to Enable X.509 Authentication
49
49
50
-
You can use Helm to install and deploy the MongoDB Community Kubernetes
51
-
Operator with X.509 Authentication enabled for the MongoDB Agent and
50
+
You can use Helm to install and deploy the MongoDB Community Kubernetes
51
+
Operator with X.509 Authentication enabled for the MongoDB Agent and
52
52
client.
53
53
54
-
1. To install the MongoDB Community Kubernetes Operator, see
54
+
1. To install the MongoDB Community Kubernetes Operator, see
55
55
[Install the Operator using kubectl](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/install-upgrade.md#install-the-operator-using-kubectl).
56
56
57
-
1. To create a CA, ConfigMap, secrets, issuer, and certificate, see
57
+
2. To create a CA, ConfigMap, secrets, issuer, and certificate, see
58
58
[Enable External Access to a MongoDB Deployment](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/external_access.md).
59
59
60
-
1. Create a YAML file for the MongoDB Agent certificate. For an example,
61
-
see [agent-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/agent-certificate.yaml).
60
+
3. Create a YAML file for the MongoDB Agent certificate. For an example,
61
+
see [agent-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/external_access/agent-certificate.yaml).
62
62
63
63
**Note:**
64
64
65
-
- For the `spec.issuerRef.name` parameter, specify the
65
+
- For the `spec.issuerRef.name` parameter, specify the
66
66
`cert-manager` issuer that you created previously.
67
-
- For the `spec.secretName` parameter, specify the same
68
-
value as the `spec.security.authentication.agentCertificateSecretRef`
69
-
parameter in your resource. This secret should contain a signed
67
+
- For the `spec.secretName` parameter, specify the same
68
+
value as the `spec.security.authentication.agentCertificateSecretRef`
69
+
parameter in your resource. This secret should contain a signed
70
70
X.509 certificate and a private key for the MongoDB agent.
71
71
72
-
1. To apply the file, copy and paste the following command and replace
73
-
the `<agent-certificate>` variable with the name of your MongoDB Agent
72
+
4. To apply the file, copy and paste the following command and replace
73
+
the `<agent-certificate>` variable with the name of your MongoDB Agent
74
74
certificate and the `<namespace>` variable with the namespace:
0 commit comments