Skip to content

Update broken links for MCO sample files #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion RELEASE_NOTES_MEKO.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
* `spec.agent.monitoringAgent.logRotation` to configure the backup agent
* `spec.agent.readinessProbe.environmentVariables` to configure the environment variables the readinessProbe runs with.
That also applies to settings related to the logRotation,
the supported environment settings can be found [here](https://github.com/mongodb/mongodb-kubernetes-operator/blob/master/docs/logging.md#readinessprobe).
the supported environment settings can be found [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/mongodbcommunity/logging.md#readinessprobe).
* the same applies for AppDB:
* you can configure AppDB via `spec.applicationDatabase.agent.mongod.logRotation`
* Please Note: For shardedCluster we only support configuring logRotation under `spec.Agent`
Expand Down
8 changes: 4 additions & 4 deletions docs/mongodbcommunity/deploy-configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ different topology than the previous ones.

To deploy your first replica set:

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

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

See [here](../config/samples/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
See [here](https://github.com/mongodb/mongodb-kubernetes/blob/master/mongodb-community-operator/config/samples/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
an example of how to provide the required configuration for a MongoDB
replica set.

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

```yaml
Expand Down
14 changes: 7 additions & 7 deletions docs/mongodbcommunity/external_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ kubectl create secret tls ca-key-pair --cert=<path-to-ca.crt> --key=<path-to-c

### Create the Cert Manager issuer and secret

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

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

```sh
kubectl apply -f config/samples/external_access/cert-manager-issuer.yaml --namespace <your-namespace>
kubectl apply -f config/samples/external_access/cert-manager-certificate.yaml --namespace <your-namespace>
kubectl apply -f mongodb-community-operator/config/samples/external_access/cert-manager-issuer.yaml --namespace <your-namespace>
kubectl apply -f mongodb-community-operator/config/samples/external_access/cert-manager-certificate.yaml --namespace <your-namespace>
```

### Create the MongoDB deployment

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

Apply the manifest.

```sh
kubectl apply -f config/samples/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <your-namespace>
kubectl apply -f mongodb-community-operator/config/samples/external_access/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <your-namespace>
```

Wait for the replicaset to be available.

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

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

Apply the manifest.

```sh
kubectl apply -f config/samples/external_access/external_services.yaml --namespace <your-namespace>
kubectl apply -f mongodb-community-operator/config/samples/external_access/external_services.yaml --namespace <your-namespace>
```

### Retrieve the certificates from a MongoDB replicaset member
Expand Down
12 changes: 6 additions & 6 deletions docs/mongodbcommunity/x509-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ MongoDB Agent and client.

You can use Helm to install and deploy the MongoDB Community Kubernetes
Operator with X.509 Authentication enabled for the MongoDB Agent and
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).
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).

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

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

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

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

**Note:**

Expand All @@ -78,7 +78,7 @@ client.
```

1. Create a YAML file for your resource. For an example, see
[mongodb.com_v1_mongodbcommunity_x509.yaml](https://github.com/mongodb/mongodb-kubernetes-operator/blob/master/config/samples/mongodb.com_v1_mongodbcommunity_x509.yaml).
[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).

**Note:**

Expand Down Expand Up @@ -118,7 +118,7 @@ client.
```

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

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