Skip to content

Commit 10fc2b0

Browse files
authored
Fix documentation (#1325)
* Fix link to users.md * Remove Ubuntu image for agent * Fix Markdown links * Fix Markdown links * Fix secure.md * Fix secure.md * Revert "Remove Ubuntu image for agent" This reverts commit 7e55793.
1 parent 4008031 commit 10fc2b0

File tree

6 files changed

+23
-22
lines changed

6 files changed

+23
-22
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ Here is a talk from MongoDB Live 2020 about the Community Operator:
2929

3030
## Documentation
3131

32-
See the [documentation](/docs) to learn how to:
32+
See the [documentation](docs) to learn how to:
3333

34-
1. [Install or upgrade](/docs/install-upgrade.md) the Operator.
35-
1. [Deploy and configure](/docs/deploy-configure.md) MongoDB resources.
36-
1. [Create a database user](/docs/users.md) with SCRAM authentication.
37-
1. [Secure MongoDB resource connections](/docs/secure.md) using TLS.
34+
1. [Install or upgrade](docs/install-upgrade.md) the Operator.
35+
1. [Deploy and configure](docs/deploy-configure.md) MongoDB resources.
36+
1. [Create a database user](docs/users.md) with SCRAM authentication.
37+
1. [Secure MongoDB resource connections](docs/secure.md) using TLS.
3838

3939
*NOTE: [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/master/) docs are for the enterprise operator use case and NOT for the community operator. In addition to the docs mentioned above, you can refer to this [blog post](https://www.mongodb.com/blog/post/run-secure-containerized-mongodb-deployments-using-the-mongo-db-community-kubernetes-oper) as well to learn more about community operator deployment*
4040

@@ -61,8 +61,8 @@ The MongoDB Community Kubernetes Operator supports the following features:
6161

6262
Before you contribute to the MongoDB Community Kubernetes Operator, please read:
6363

64-
- [MongoDB Community Kubernetes Operator Architecture](/docs/architecture.md)
65-
- [Contributing to MongoDB Community Kubernetes Operator](/docs/contributing.md)
64+
- [MongoDB Community Kubernetes Operator Architecture](docs/architecture.md)
65+
- [Contributing to MongoDB Community Kubernetes Operator](docs/contributing.md)
6666

6767
Please file issues before filing PRs. For PRs to be accepted, contributors must sign our [CLA](https://www.mongodb.com/legal/contributor-agreement).
6868

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Table of Contents
44

5-
- [Contribute to the MongoDB Kubernetes Operator](/docs/contributing.md)
6-
- [MongoDB Community Kubernetes Operator Architecture](/docs/architecture.md)
7-
- [Install and Upgrade the Community Kubernetes Operator](/docs/install-upgrade.md)
8-
- [Deploy and Configure MongoDBCommunity Resources](/docs/deploy-configure.md)
9-
- [Create Database Users](/docs/users.md)
10-
- [Secure MongoDBCommunity Resources](/docs/secure.md)
5+
- [Contribute to the MongoDB Kubernetes Operator](contributing.md)
6+
- [MongoDB Community Kubernetes Operator Architecture](architecture.md)
7+
- [Install and Upgrade the Community Kubernetes Operator](install-upgrade.md)
8+
- [Deploy and Configure MongoDBCommunity Resources](deploy-configure.md)
9+
- [Create Database Users](users.md)
10+
- [Secure MongoDBCommunity Resources](secure.md)

docs/build_operator_locally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ git submodule update --init
4747
make all-images deploy
4848
```
4949

50-
Note: this will build and push the operator at `repo_url/mongodb-kubernetes-operator`, where `repo_url` is extracted from the [dev config file](./contributing.md#developing-locally)
50+
Note: this will build and push the operator at `repo_url/mongodb-kubernetes-operator`, where `repo_url` is extracted from the [dev config file](./contributing.md#developer-configuration)
5151

5252
6. Change the `image` field in the [manager.yaml](../config/manager/manager.yaml) file to have the image you just built
5353

docs/deploy-configure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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](../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

docs/prometheus/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Kubernetes Operator and resources:
4747
helm install community-operator mongodb/community-operator --namespace <mongodb> --create-namespace
4848
```
4949

50-
To learn more, see the [Installation Instructions](/docs/install-upgrade.md#operator-in-same-namespace-as-resources).
50+
To learn more, see the [Installation Instructions](../install-upgrade.md#operator-in-same-namespace-as-resources).
5151

5252
## Create a MongoDB Resource
5353

@@ -104,7 +104,7 @@ namespace.
104104
a. Run the following command to create a `Secret` that
105105
contains the TLS certificate `tls.crt` and `tls.key`
106106
entries. You can use the certificate and key files that
107-
we provide in the [`testdata/tls`](/testdata/tls) directory to create a Cert-Manager `Certificate`.
107+
we provide in the [`testdata/tls`](../../testdata/tls) directory to create a Cert-Manager `Certificate`.
108108

109109
``` shell
110110
kubectl create secret tls issuer-secret --cert=../../testdata/tls/ca.crt --key=../../testdata/tls/ca.key \

docs/secure.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ certificates to encrypt traffic between:
1515
- Client applications and MongoDB deployments.
1616

1717
The Operator automates TLS configuration through its integration with
18-
[cert-manager](cert-manager.io), a certificate management tool for
18+
[cert-manager](https://cert-manager.io/), a certificate management tool for
1919
Kubernetes.
2020

2121
### Prerequisites
2222

2323
Before you secure MongoDBCommunity resource connections using TLS, you
24-
must [Create a database user](docs/users) to authenticate to your
24+
must [Create a database user](../docs/users.md) to authenticate to your
2525
MongoDBCommunity resource.
2626

2727
### Procedure
@@ -46,9 +46,10 @@ To secure connections to MongoDBCommunity resources with TLS using `cert-manager
4646
1. Create a TLS-secured MongoDBCommunity resource:
4747

4848
```
49-
helm upgrade community-operator mongodb/community-operator \
50-
--namespace cko-namespace --set resource.tls.useCertManager=true \
51-
--set createResource=true --set resource.tls.enabled=true
49+
helm upgrade --install community-operator mongodb/community-operator \
50+
--namespace mongodb --set resource.tls.useCertManager=true \
51+
--set createResource=true --set resource.tls.enabled=true \
52+
--set namespace=mongodb --create-namespace
5253
```
5354

5455
This creates a resource secured with TLS and generates the necessary

0 commit comments

Comments
 (0)