You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sources/k6/next/set-up/set-up-distributed-k6/install-k6-operator.md
+39-21Lines changed: 39 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ To install k6 Operator, you'll need:
16
16
17
17
## Deploy the operator
18
18
19
-
There are three different options that you can use to deploy the k6 Operator.
19
+
There are three different methods to deploy the k6 Operator. The first two methods, with bundle and Helm, install the latest official release of the k6 Operator by default. The third method installs from the branch of the [k6-operator repository](https://github.com/grafana/k6-operator) and is intended for development purposes or for users who have their own `kustomize` pipeline.
20
20
21
21
### Deploy with bundle
22
22
@@ -50,27 +50,59 @@ You can find a complete list of Helm options in the [k6 Operator charts folder](
50
50
51
51
### Deploy with Makefile
52
52
53
-
In order to install the operator with a Makefile, you'll need:
53
+
This method installs the k6 Operator from the GitHub repository, using the latest files in a branch. By default, it uses the `main` branch, which is not guaranteed to be stable at all times. This method is helpful for:
54
+
55
+
- Development purposes.
56
+
- Users who have a `kustomize` pipeline and want to adjust manifests with it.
57
+
58
+
To use this method for production deployments, it's recommended to do that from the tagged commits:
A more manual, low-level way to install the k6 operator is by running the command below:
72
+
Then, you can install the k6 Operator by running the command below from the root of the cloned repository:
59
73
60
74
```bash
61
75
make deploy
62
76
```
63
77
64
-
This method may be more useful for development of the k6 Operator, depending on specifics of the setup.
78
+
### Install the CRDs
65
79
66
-
## Install the CRD
67
-
68
-
The k6 Operator includes custom resources called `TestRun`, `PrivateLoadZone`, and `K6`. They're automatically installed when you do a deployment or install a bundle, but you can also manually install them by running:
80
+
The k6 Operator includes custom resources called `TestRun` and `PrivateLoadZone`. They're automatically installed when you use one of the three installation methods above. But you can also manually install the CRDs by running:
69
81
70
82
```bash
71
83
make install
72
84
```
73
85
86
+
## Uninstall k6 Operator
87
+
88
+
Removal of the k6 Operator depends on the installation method. If you use the bundle installation method, you can remove all of the resources created by the k6 Operator with the following:
Copy file name to clipboardExpand all lines: docs/sources/k6/v1.1.x/set-up/set-up-distributed-k6/install-k6-operator.md
+39-21Lines changed: 39 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ To install k6 Operator, you'll need:
16
16
17
17
## Deploy the operator
18
18
19
-
There are three different options that you can use to deploy the k6 Operator.
19
+
There are three different methods to deploy the k6 Operator. The first two methods, with bundle and Helm, install the latest official release of the k6 Operator by default. The third method installs from the branch of the [k6-operator repository](https://github.com/grafana/k6-operator) and is intended for development purposes or for users who have their own `kustomize` pipeline.
20
20
21
21
### Deploy with bundle
22
22
@@ -50,27 +50,59 @@ You can find a complete list of Helm options in the [k6 Operator charts folder](
50
50
51
51
### Deploy with Makefile
52
52
53
-
In order to install the operator with a Makefile, you'll need:
53
+
This method installs the k6 Operator from the GitHub repository, using the latest files in a branch. By default, it uses the `main` branch, which is not guaranteed to be stable at all times. This method is helpful for:
54
+
55
+
- Development purposes.
56
+
- Users who have a `kustomize` pipeline and want to adjust manifests with it.
57
+
58
+
To use this method for production deployments, it's recommended to do that from the tagged commits:
A more manual, low-level way to install the k6 operator is by running the command below:
72
+
Then, you can install the k6 Operator by running the command below from the root of the cloned repository:
59
73
60
74
```bash
61
75
make deploy
62
76
```
63
77
64
-
This method may be more useful for development of the k6 Operator, depending on specifics of the setup.
78
+
### Install the CRDs
65
79
66
-
## Install the CRD
67
-
68
-
The k6 Operator includes custom resources called `TestRun`, `PrivateLoadZone`, and `K6`. They're automatically installed when you do a deployment or install a bundle, but you can also manually install them by running:
80
+
The k6 Operator includes custom resources called `TestRun` and `PrivateLoadZone`. They're automatically installed when you use one of the three installation methods above. But you can also manually install the CRDs by running:
69
81
70
82
```bash
71
83
make install
72
84
```
73
85
86
+
## Uninstall k6 Operator
87
+
88
+
Removal of the k6 Operator depends on the installation method. If you use the bundle installation method, you can remove all of the resources created by the k6 Operator with the following:
0 commit comments