Skip to content

Commit

Permalink
updates (still work in progress)
Browse files Browse the repository at this point in the history
  • Loading branch information
Amper committed Sep 21, 2023
1 parent 18972f7 commit 3b3cf01
Show file tree
Hide file tree
Showing 5 changed files with 187 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ title: Enterprise features

# Using operator with enterprise features

TODO
Operator doesn't have enterprise version for itself, but it supports enterprise features VictoriaMetrics components.

<-- TODO -->

4 changes: 4 additions & 0 deletions docs/resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ Every custom resource with deployable application has a fields for specifying ve
- [vmcluster](https://docs.victoriametrics.com/operator/resources/vmcluster.html#version-management)
- [vmsingle](https://docs.victoriametrics.com/operator/resources/vmsingle.html#version-management)

## Enterprise features

<-- TODO -->

## Configuration synchronization

### Basic concepts
Expand Down
85 changes: 85 additions & 0 deletions docs/resources/vmagent.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,91 @@ spec:
# ...
```

## Enterprise features

VMAgent supports feature [Kafka integration](https://docs.victoriametrics.com/vmagent.html#kafka-integration)
from [VictoriaMetrics Enterprise](https://docs.victoriametrics.com/enterprise.html#victoriametrics-enterprise).

For using Enterprise version of [vmagent](https://docs.victoriametrics.com/vmagent.html)
you need to change version of `vmagent` to version with `-enterprise` suffix using [Version management](#version-management).

All the enterprise apps require `-eula` command-line flag to be passed to them.
This flag acknowledges that your usage fits one of the cases listed on [this page](https://docs.victoriametrics.com/enterprise.html#victoriametrics-enterprise).
So you can use [extraArgs](https://docs.victoriametrics.com/operator/resources/#extra-args) for passing this flag to `VMAgent`:

After that you can pass [Kafka integration](https://docs.victoriametrics.com/vmagent.html#kafka-integration)
flags to `VMAgent` with [extraArgs](https://docs.victoriametrics.com/operator/resources/#extra-args).

### Reading metrics from Kafka

Here are complete example for [Reading metrics from Kafka](https://docs.victoriametrics.com/vmagent.html#reading-metrics-from-kafka):

```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: vmagent-ent-example
spec:
# enabling enterprise features
image:
# enterprise version of vmagent
tag: v1.93.5-enterprise
extraArgs:
# should be true and means that you have the legal right to run a vmagent enterprise
# that can either be a signed contract or an email with confirmation to run the service in a trial period
# https://victoriametrics.com/legal/esa/
eula: true
# using enterprise features: reading metrics from kafka
# more details about kafka integration you can read on https://docs.victoriametrics.com/vmagent.html#kafka-integration
# more details about these and other flags you can read on https://docs.victoriametrics.com/vmagent.html#command-line-flags-for-kafka-consumer
kafka.consumer.topic.brokers: localhost:9092
kafka.consumer.topic.format: influx
kafka.consumer.topic: metrics-by-telegraf
kafka.consumer.topic.groupID: some-id
# ...other fields...
```

### Writing metrics to Kafka

Here are complete example for [Writing metrics to Kafka](https://docs.victoriametrics.com/vmagent.html#writing-metrics-to-kafka):

```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: vmagent-ent-example
spec:
# enabling enterprise features
image:
# enterprise version of vmagent
tag: v1.93.5-enterprise
extraArgs:
# should be true and means that you have the legal right to run a vmagent enterprise
# that can either be a signed contract or an email with confirmation to run the service in a trial period
# https://victoriametrics.com/legal/esa/
eula: true
# using enterprise features: writing metrics to Kafka
# more details about kafka integration you can read on https://docs.victoriametrics.com/vmagent.html#kafka-integration
remoteWrite:
# sasl with username and password
- url: kafka://localhost:9092/?topic=prom-rw&security.protocol=SASL_SSL&sasl.mechanisms=PLAIN
basicAuth:
username: user
password: password
# sasl with username and password from secret
- url: kafka://localhost:9092/?topic=prom-rw&security.protocol=SASL_SSL&sasl.mechanisms=PLAIN
basicAuth:
username: user
passwordFile: /etc/vmagent/secrets/kafka-password.txt
# sasl with username and password from secret and tls
# ...other fields...
```

## Examples

```yaml
Expand Down
66 changes: 66 additions & 0 deletions docs/resources/vmauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,72 @@ spec:
# ...
```

## Enterprise features

Custom resource `VMAuth` supports feature [IP filters](https://docs.victoriametrics.com/vmauth.html#ip-filters)
from [VictoriaMetrics Enterprise](https://docs.victoriametrics.com/enterprise.html#victoriametrics-enterprise).

For using Enterprise version of [vmauth](https://docs.victoriametrics.com/vmauth.html)
you need to change version of `vmauth` to version with `-enterprise` suffix using [Version management](#version-management).

All the enterprise apps require `-eula` command-line flag to be passed to them.
This flag acknowledges that your usage fits one of the cases listed on [this page](https://docs.victoriametrics.com/enterprise.html#victoriametrics-enterprise).
So you can use [extraArgs](https://docs.victoriametrics.com/operator/resources/#extra-args) for passing this flag to `VMAuth`:

### IP Filters

After that you can use [IP filters for `VMUser`](http://docs.victoriametrics.com/operator/resources/vmuser.html#enterprise-features)
and field `ip_filters` for `VMAuth`:

Here are complete example with described above:

```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAuth
metadata:
name: vmauth-ent-example
spec:
# enabling enterprise features
image:
# enterprise version of vmauth
tag: v1.93.5-enterprise
extraArgs:
# should be true and means that you have the legal right to run a vmauth enterprise
# that can either be a signed contract or an email with confirmation to run the service in a trial period
# https://victoriametrics.com/legal/esa/
eula: true
# using enterprise features: ip filters for vmauth
# more details about ip filters you can read in https://docs.victoriametrics.com/vmauth.html#ip-filters
ip_filters:
allow_list:
- 10.0.0.0/24
- 1.2.3.4
deny_list:
- 5.6.7.8
# ...other fields...
---
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
name: vmuser-ent-example
spec:
username: simple-user
password: simple-password
# using enterprise features: ip filters for vmuser
# more details about ip filters you can read in https://docs.victoriametrics.com/vmuser.html#enterprise-features
ip_filters:
allow_list:
- 10.0.0.0/24
- 1.2.3.4
deny_list:
- 5.6.7.8
```

## Examples

```yaml
Expand Down
29 changes: 29 additions & 0 deletions docs/resources/vmuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,35 @@ Also, you can check out the [examples](#examples) section.

Additional fields like `path` and `scheme` can be added to `CRDRef` config.

## Enterprise features

Custom resource `VMUser` supports feature [IP filters](https://docs.victoriametrics.com/vmauth.html#ip-filters)
from [VictoriaMetrics Enterprise](https://docs.victoriametrics.com/enterprise.html#victoriametrics-enterprise).

For using [IP filters](https://docs.victoriametrics.com/vmauth.html#ip-filters)
you need to **[enable VMAuth Enterprise](https://docs.victoriametrics.com/operator/resources/vmauth.html#enterprise-features)**.

After that you can add `ip_filters` feild in `VMUser`:

```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMUser
metadata:
name: vmuser-ent-example
spec:
username: simple-user
password: simple-password

# using enterprise features: ip filters for vmuser
# more details about ip filters you can read in https://docs.victoriametrics.com/vmuser.html#enterprise-features
ip_filters:
allow_list:
- 10.0.0.0/24
- 1.2.3.4
deny_list:
- 5.6.7.8
```
## Examples
```yaml
Expand Down

0 comments on commit 3b3cf01

Please sign in to comment.