Skip to content

Commit e26dc91

Browse files
authored
Fix community sample links after #463 (#519)
# 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
1 parent c43f2fe commit e26dc91

File tree

3 files changed

+50
-50
lines changed

3 files changed

+50
-50
lines changed

docs/mongodbcommunity/deploy-configure.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ The [`/config/samples`](../config/samples) directory contains example MongoDBCom
1717
## Deploy a Replica Set
1818

1919
**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
2222
pre-existing data might cause issues if the new MongoDB resources have a
2323
different topology than the previous ones.
2424

2525
To deploy your first replica set:
2626

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.
2828
2. Invoke the following `kubectl` command:
2929
```
30-
kubectl apply -f mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <my-namespace>
30+
kubectl apply -f public/samples/community/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <my-namespace>
3131
```
3232
3. Verify that the MongoDBCommunity resource deployed:
3333
```
@@ -258,7 +258,7 @@ To upgrade this resource from `4.0.6` to `4.2.7`:
258258

259259
To deploy the operator on OpenShift you will have to provide the environment variable `MANAGED_SECURITY_CONTEXT` set to `true` for the operator deployment.
260260

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
262262
an example of how to provide the required configuration for a MongoDB
263263
replica set.
264264

@@ -344,7 +344,7 @@ Under some circumstances it might be necessary to set your own custom values for
344344
the `ReadinessProbe` used by the MongoDB Community Operator. To do so, you
345345
should use the `statefulSet` attribute in `resource.spec`, as in the following
346346
provided example [yaml
347-
file](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_readiness_probe_values.yaml).
347+
file](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/mongodb.com_v1_mongodbcommunity_readiness_probe_values.yaml).
348348
Only those attributes passed will be set, for instance, given the following structure:
349349

350350
```yaml
@@ -392,4 +392,4 @@ For ex:
392392
env:
393393
- name: CLUSTER_DOMAIN
394394
value: $CUSTOM_DOMAIN
395-
```
395+
```

docs/mongodbcommunity/external_access.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ kubectl create secret tls ca-key-pair --cert=<path-to-ca.crt> --key=<path-to-c
3737

3838
### Create the Cert Manager issuer and secret
3939

40-
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:
4141

4242
```yaml
4343
...
@@ -57,30 +57,30 @@ spec:
5757
Apply the manifests. Replace ```<your-namespace>``` with the namespace you are using for the deployment.
5858

5959
```sh
60-
kubectl apply -f mongodb-community-operator/config/samples/external_access/cert-manager-issuer.yaml --namespace <your-namespace>
61-
kubectl apply -f mongodb-community-operator/config/samples/external_access/cert-manager-certificate.yaml --namespace <your-namespace>
60+
kubectl apply -f public/samples/community/external_access/cert-manager-issuer.yaml --namespace <your-namespace>
61+
kubectl apply -f public/samples/community/external_access/cert-manager-certificate.yaml --namespace <your-namespace>
6262
```
6363

6464
### Create the MongoDB deployment
6565

66-
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.
6767

6868
Apply the manifest.
6969

7070
```sh
71-
kubectl apply -f mongodb-community-operator/config/samples/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <your-namespace>
71+
kubectl apply -f public/samples/community/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <your-namespace>
7272
```
7373

7474
Wait for the replicaset to be available.
7575

7676
### Create the external NodePort services for accessing the MongoDB deployment from outside the Kubernetes cluster
7777

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.
7979

8080
Apply the manifest.
8181

8282
```sh
83-
kubectl apply -f mongodb-community-operator/config/samples/external_access/external_services.yaml --namespace <your-namespace>
83+
kubectl apply -f public/samples/community/external_access/external_services.yaml --namespace <your-namespace>
8484
```
8585

8686
### Retrieve the certificates from a MongoDB replicaset member

docs/mongodbcommunity/x509-auth.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enable X.509 Authentication
22

3-
You can use Helm or `kubectl` to enable X.509 authentication for the
3+
You can use Helm or `kubectl` to enable X.509 authentication for the
44
MongoDB Agent and client.
55

66
## Prerequisites
@@ -16,25 +16,25 @@ MongoDB Agent and client.
1616
1. Install `cert-manager`:
1717

1818
```
19-
helm install cert-manager jetstack/cert-manager --namespace cert-manager \
19+
helm install cert-manager jetstack/cert-manager --namespace cert-manager \
2020
--create-namespace --set installCRDs=true
2121
```
2222

2323
## Use Helm to Enable X.509 Authentication
2424

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
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
2727
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).
2828

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
3131
namespace:
3232

3333
**Note:**
3434

3535
The following command deploys a sample resource with X.509 enabled
3636
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
3838
authenticate.
3939

4040
```
@@ -47,81 +47,81 @@ client. To learn more, see [Install the Operator using Helm](https://github.com/
4747

4848
## Use `kubectl` to Enable X.509 Authentication
4949

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
5252
client.
5353

54-
1. To install the MongoDB Community Kubernetes Operator, see
54+
1. To install the MongoDB Community Kubernetes Operator, see
5555
[Install the Operator using kubectl](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/install-upgrade.md#install-the-operator-using-kubectl).
5656

57-
1. To create a CA, ConfigMap, secrets, issuer, and certificate, see
57+
2. To create a CA, ConfigMap, secrets, issuer, and certificate, see
5858
[Enable External Access to a MongoDB Deployment](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/external_access.md).
5959

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).
6262

6363
**Note:**
6464

65-
- For the `spec.issuerRef.name` parameter, specify the
65+
- For the `spec.issuerRef.name` parameter, specify the
6666
`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
7070
X.509 certificate and a private key for the MongoDB agent.
7171

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
7474
certificate and the `<namespace>` variable with the namespace:
7575

7676
```
7777
kubectl apply -f <agent-certificate>.yaml --namespace <namespace>
7878
```
7979

80-
1. Create a YAML file for your resource. For an example, see
81-
[mongodb.com_v1_mongodbcommunity_x509.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_x509.yaml).
80+
5. Create a YAML file for your resource. For an example, see
81+
[mongodb.com_v1_mongodbcommunity_x509.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/mongodb.com_v1_mongodbcommunity_x509.yaml).
8282

8383
**Note:**
8484

8585
- For the `spec.security.tls.certificateKeySecretRef.name` parameter,
8686
specify a reference to the secret that contains the private key and
87-
certificate to use for TLS. The operator expects the PEM encoded key
88-
and certificate available at "tls.key" and "tls.crt". Use the same
89-
format used for the standard "kubernetes.io/tls" Secret type, but no
90-
specific type is required. Alternatively, you can provide
91-
an entry called "tls.pem" that contains the concatenation of the
92-
certificate and key. If all of "tls.pem", "tls.crt" and "tls.key"
93-
are present, the "tls.pem" entry needs to equal the concatenation
87+
certificate to use for TLS. The operator expects the PEM encoded key
88+
and certificate available at "tls.key" and "tls.crt". Use the same
89+
format used for the standard "kubernetes.io/tls" Secret type, but no
90+
specific type is required. Alternatively, you can provide
91+
an entry called "tls.pem" that contains the concatenation of the
92+
certificate and key. If all of "tls.pem", "tls.crt" and "tls.key"
93+
are present, the "tls.pem" entry needs to equal the concatenation
9494
of "tls.crt" and "tls.key".
9595

9696
- For the `spec.security.tls.caConfigMapRef.name` parameter, specify
9797
the ConfigMap that you created previously.
9898

9999
- For the `spec.authentication.modes` parameter, specify `X509`.
100-
101-
- If you have multiple authentication modes, specify the
100+
101+
- If you have multiple authentication modes, specify the
102102
`spec.authentication.agentMode` parameter.
103103

104104
- The `spec.authentication.agentCertificateSecretRef` parameter
105105
defaults to `agent-certs`.
106106

107107
- For the `spec.users.db` parameter, specify `$external`.
108108

109-
- Do not set the `spec.users.scramCredentialsSecretName` parameter
109+
- Do not set the `spec.users.scramCredentialsSecretName` parameter
110110
and the `spec.users.passwordSecretRef` parameters.
111111

112-
1. To apply the file, copy and paste the following command and replace
112+
6. To apply the file, copy and paste the following command and replace
113113
the `<replica-set>` variable with your resource and the `<namespace>`
114114
variable with the namespace:
115115

116116
```
117117
kubectl apply -f <replica-set>.yaml --namespace <namespace>
118118
```
119119

120-
1. Create a YAML file for the client certificate. For an example, see
121-
[cert-x509.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/cert-x509.yaml).
120+
7. Create a YAML file for the client certificate. For an example, see
121+
[cert-x509.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/public/samples/community/external_access/cert-x509.yaml).
122122

123-
1. To apply the file, copy and paste the following command and replace
124-
the `<client-certificate>` variable with the name of your client
123+
8. To apply the file, copy and paste the following command and replace
124+
the `<client-certificate>` variable with the name of your client
125125
certificate and the `<namespace>` variable with the namespace:
126126

127127
```

0 commit comments

Comments
 (0)