Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.

Commit 022b983

Browse files
Tech review
1 parent 8beec7b commit 022b983

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

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

33
<img align="left" src="https://mongodb-kubernetes-operator.s3.amazonaws.com/img/Leaf-Forest%402x.png">
44

5-
This is a Kubernetes Operator (https://coreos.com/operators/) which deploys MongoDB Community into Kubernetes clusters.
5+
This is a [Kubernetes Operator](https://coreos.com/operators/) which deploys MongoDB Community into Kubernetes clusters.
66

77
This codebase is currently _pre-alpha_, and is not ready for use.
88

@@ -14,16 +14,17 @@ If you are a MongoDB Enterprise customer, or need Enterprise features such as Ba
1414

1515
Before you install the MongoDB Community Kubernetes Operator, you must:
1616

17-
1. Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
18-
2. Install [kind](https://kind.sigs.k8s.io/)
17+
1. Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
18+
2. Have a Kubernetes solution available to use.
19+
If you need a Kubernetes solution, see the [Kubernetes documentation on picking the right solution](https://kubernetes.io/docs/setup). For testing, MongoDB recommends [Kind](https://kind.sigs.k8s.io/).
1920
3. Clone this repository.
2021
```
2122
git clone https://github.com/mongodb/mongodb-kubernetes-operator.git
2223
```
2324

2425
### Installing the MongoDB Community Kubernetes Operator
2526

26-
The MongoDB Community Kubernetes Operator is a collection of [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) and a controller.
27+
The MongoDB Community Kubernetes Operator is a [Custom Resource Definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) and a controller.
2728

2829
To install the MongoDB Community Kubernetes Operator:
2930

@@ -38,14 +39,13 @@ To install the MongoDB Community Kubernetes Operator:
3839
kubectl get crd/mongodb.mongodb.com
3940
```
4041
3. Install the Operator.
41-
a. Invoke the following `kubectl` command to install the Operator in the `default` namespace:
42+
a. Invoke the following `kubectl` command to install the Operator in the specified namespace:
4243
```
43-
kubectl create -f deploy
44+
kubectl create -f deploy --namespace <my-namespace>
4445
```
45-
To install the Operator in a different namespace, append the `--namespace <my-namespace>` option.
4646
b. Verify that the Operator installed successsfully:
4747
```
48-
kubectl get pods
48+
kubectl get pods --namespace <my-namespace>
4949
```
5050
5151
## Usage
@@ -58,11 +58,11 @@ To deploy your first replica set:
5858
5959
1. Invoke the following `kubectl` command:
6060
```
61-
kubectl apply -f deploy/crds/mongodb.com_v1_mongodb_cr.yaml
61+
kubectl apply -f deploy/crds/mongodb.com_v1_mongodb_cr.yaml --namespace <my-namespace>
6262
```
6363
2. Verify that the MongoDB resource deployed:
6464
```
65-
kubectl get mongodb
65+
kubectl get mongodb --namespace <my-namespace>
6666
```
6767
6868
## Contributing

0 commit comments

Comments
 (0)