mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
Automatic update operator docs from VictoriaMetrics/operator@4774786 (#6617)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Github Actions
GitHub
parent
6a4bd5049b
commit
c688b53f56
2 changed files with 30 additions and 45 deletions
|
|
@ -13,6 +13,17 @@ aliases:
|
|||
---
|
||||
# CHANGELOG
|
||||
|
||||
## [v0.46.4](https://github.com/VictoriaMetrics/operator/releases/tag/v0.46.4) - 9 Jul 2024
|
||||
|
||||
### Breaking changes
|
||||
|
||||
- **Update note 1: for operatorhub based `VMAgent` deployment `serviceAccount` `vmagent` must be removed. It's no longer shipped with bundle. After deletion operator will create new account with needed permissions.**
|
||||
|
||||
- [manifests]: properly add webhook.enable for operatorhub deployments. See this commit 7a460b090dec018ea23ab8d9de414e2f7da1c513 for details.
|
||||
- [manifests]: removes exact user from `runAsUser` setting. It must be defined at `docker image` or `security profile` level. See this commit 1cc4a0e5334f254a771fa06e9c07dfa93fbb734a for details.
|
||||
- [operator](./README.md): switches from distroless to scratch base image. See this commit 768bf76bdd1ce2080c214cf164f95711d836b960 for details.
|
||||
- [config-reloader](./README.md): do not specify `command` for container. `command` configured at `docker image` level. See this commit 2192115488e6f2be16bde7ddd71426e305a16144 for details.
|
||||
|
||||
## [v0.46.3](https://github.com/VictoriaMetrics/operator/releases/tag/v0.46.3) - 5 Jul 2024
|
||||
|
||||
- [operator](./README.md): fixes `config-reloader` image tag name after 0.46.0 release. See this [issue](https://github.com/VictoriaMetrics/operator/issues/1017) for details.
|
||||
|
|
|
|||
|
|
@ -27,50 +27,6 @@ or [this](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/vict
|
|||
in addition, you can use [quickstart guide](./quick-start.md) for
|
||||
installing VictoriaMetrics operator with helm-chart.
|
||||
|
||||
## Installing by Manifest
|
||||
|
||||
Obtain release from releases page:
|
||||
[https://github.com/VictoriaMetrics/operator/releases](https://github.com/VictoriaMetrics/operator/releases)
|
||||
|
||||
We suggest use the latest release.
|
||||
|
||||
```sh
|
||||
# Get latest release version from https://github.com/VictoriaMetrics/operator/releases/latest
|
||||
export VM_VERSION=`basename $(curl -fs -o/dev/null -w %{redirect_url} https://github.com/VictoriaMetrics/operator/releases/latest)`
|
||||
wget https://github.com/VictoriaMetrics/operator/releases/download/$VM_VERSION/bundle_crd.zip
|
||||
unzip bundle_crd.zip
|
||||
```
|
||||
|
||||
Operator use `monitoring-system` namespace, but you can install it to specific namespace with command:
|
||||
|
||||
```sh
|
||||
sed -i "s/namespace: monitoring-system/namespace: YOUR_NAMESPACE/g" release/operator/*
|
||||
```
|
||||
|
||||
First of all, you have to create [custom resource definitions](https://github.com/VictoriaMetrics/operator):
|
||||
|
||||
```sh
|
||||
kubectl apply -f release/crds
|
||||
```
|
||||
|
||||
Then you need RBAC for operator, relevant configuration for the release can be found at `release/operator/rbac.yaml`.
|
||||
|
||||
Change configuration for operator at `release/operator/manager.yaml`, possible settings: [operator-settings](/operator/vars.html)
|
||||
and apply it:
|
||||
|
||||
```sh
|
||||
kubectl apply -f release/operator/
|
||||
```
|
||||
|
||||
Check the status of operator
|
||||
|
||||
```sh
|
||||
kubectl get pods -n monitoring-system
|
||||
|
||||
#NAME READY STATUS RESTARTS AGE
|
||||
#vm-operator-667dfbff55-cbvkf 1/1 Running 0 101s
|
||||
```
|
||||
|
||||
## Installing by Kustomize
|
||||
|
||||
You can install operator using [Kustomize](https://kustomize.io/) by pointing to the remote kustomization file.
|
||||
|
|
@ -78,6 +34,7 @@ You can install operator using [Kustomize](https://kustomize.io/) by pointing to
|
|||
```sh
|
||||
# Get latest release version from https://github.com/VictoriaMetrics/operator/releases/latest
|
||||
export VM_VERSION=`basename $(curl -fs -o/dev/null -w %{redirect_url} https://github.com/VictoriaMetrics/operator/releases/latest)`
|
||||
export NAMESPACE="whatever-namespace"
|
||||
|
||||
cat << EOF > kustomization.yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
|
|
@ -85,6 +42,8 @@ kind: Kustomization
|
|||
resources:
|
||||
- github.com/VictoriaMetrics/operator/config/default?ref=${VM_VERSION}
|
||||
|
||||
namespace: ${NAMESPACE}
|
||||
|
||||
images:
|
||||
- name: victoriametrics/operator
|
||||
newTag: ${VM_VERSION}
|
||||
|
|
@ -108,12 +67,27 @@ kubectl apply -f monitoring.yaml
|
|||
Check the status of operator
|
||||
|
||||
```sh
|
||||
kubectl get pods -n monitoring-system
|
||||
kubectl get pods -n whatever-namespace
|
||||
|
||||
#NAME READY STATUS RESTARTS AGE
|
||||
#vm-operator-667dfbff55-cbvkf 1/1 Running 0 101s
|
||||
```
|
||||
|
||||
## Installing by OLM
|
||||
|
||||
### Installing to K8s
|
||||
|
||||
TODO
|
||||
|
||||
### Installing to Openshift
|
||||
|
||||
TODO
|
||||
|
||||
### Run locally
|
||||
|
||||
It's possible to build and run OLM package locally on Kind K8s cluster using `make deploy-kind-olm`.
|
||||
Command builds operator image, bundle and index images, runs Kind with a local registry and deploys OLM package to Kind.
|
||||
|
||||
## Installing to ARM
|
||||
|
||||
There is no need in an additional configuration for ARM. Operator and VictoriaMetrics have full support for it.
|
||||
|
|
|
|||
Loading…
Reference in a new issue