Skip to content

Commit cf456b6

Browse files
authored
Update broken links for MCO sample files (#219)
# Summary Fix broken links for MCO samples files: #187
1 parent b338418 commit cf456b6

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

RELEASE_NOTES_MEKO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
* `spec.agent.monitoringAgent.logRotation` to configure the backup agent
131131
* `spec.agent.readinessProbe.environmentVariables` to configure the environment variables the readinessProbe runs with.
132132
That also applies to settings related to the logRotation,
133-
the supported environment settings can be found [here](https://github.com/mongodb/mongodb-kubernetes-operator/blob/master/docs/logging.md#readinessprobe).
133+
the supported environment settings can be found [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/mongodbcommunity/logging.md#readinessprobe).
134134
* the same applies for AppDB:
135135
* you can configure AppDB via `spec.applicationDatabase.agent.mongod.logRotation`
136136
* Please Note: For shardedCluster we only support configuring logRotation under `spec.Agent`

docs/mongodbcommunity/deploy-configure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ different topology than the previous ones.
2424

2525
To deploy your first replica set:
2626

27-
1. Replace `<your-password-here>` in [config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml](../config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml) to the password you wish to use.
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.
2828
2. Invoke the following `kubectl` command:
2929
```
30-
kubectl apply -f config/samples/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <my-namespace>
30+
kubectl apply -f mongodb-community-operator/config/samples/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](../config/samples/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
261+
See [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/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](../config/samples/mongodb.com_v1_mongodbcommunity_readiness_probe_values.yaml).
347+
file](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/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

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](../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/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:
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 config/samples/external_access/cert-manager-issuer.yaml --namespace <your-namespace>
61-
kubectl apply -f config/samples/external_access/cert-manager-certificate.yaml --namespace <your-namespace>
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>
6262
```
6363

6464
### Create the MongoDB deployment
6565

66-
Edit [mongodb.com_v1_mongodbcommunity_cr.yaml](../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/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.
6767

6868
Apply the manifest.
6969

7070
```sh
71-
kubectl apply -f config/samples/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <your-namespace>
71+
kubectl apply -f mongodb-community-operator/config/samples/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](../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/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.
7979

8080
Apply the manifest.
8181

8282
```sh
83-
kubectl apply -f config/samples/external_access/external_services.yaml --namespace <your-namespace>
83+
kubectl apply -f mongodb-community-operator/config/samples/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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ MongoDB Agent and client.
2424

2525
You can use Helm to install and deploy the MongoDB Community Kubernetes
2626
Operator with X.509 Authentication enabled for the MongoDB Agent and
27-
client. To learn more, see [Install the Operator using Helm](https://github.com/mongodb/mongodb-kubernetes-operator/blob/master/docs/install-upgrade.md#install-the-operator-using-helm).
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).
2828

2929
1. To deploy the MongoDB Community Kubernetes Operator, copy and paste
3030
the following command and replace the `<namespace>` variable with the
@@ -52,13 +52,13 @@ Operator with X.509 Authentication enabled for the MongoDB Agent and
5252
client.
5353

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

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

6060
1. Create a YAML file for the MongoDB Agent certificate. For an example,
61-
see [agent-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes-operator/blob/master/config/samples/external_access/agent-certificate.yaml).
61+
see [agent-certificate.yaml](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/external_access/agent-certificate.yaml).
6262

6363
**Note:**
6464

@@ -78,7 +78,7 @@ client.
7878
```
7979

8080
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-operator/blob/master/config/samples/mongodb.com_v1_mongodbcommunity_x509.yaml).
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).
8282

8383
**Note:**
8484

@@ -118,7 +118,7 @@ client.
118118
```
119119

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

123123
1. To apply the file, copy and paste the following command and replace
124124
the `<client-certificate>` variable with the name of your client

0 commit comments

Comments
 (0)