Quick links:
- Installation options :
- Access to Kibana Dashboard
- Configuration options
RPM
- Run:
rpm -ivh https://opster-rpms.s3.amazonaws.com/operator/opster-operator-v1.2.22.noarch.rpm
- Fill the /opt/opster/operator/configs/opster_operator.env file with respective values:
SERVICE_PORT={PORT}
VISUALIZATION_URL={URL}
ES_CLUSTERS={JSON_ARRAY}
ES_BACKEND={https or=“” http=“”}://{ES_HOST}:{ES_PORT}
ES_BACKEND_USER={ES_USER}
ES_BACKEND_PASSWORD={ES_PASS}
ES_LOGS_BACKEND={ES_HOST}
ES_LOGS_BACKEND_PORT={ES_PORT}
ES_LOGS_BACKEND_USER={ES_USER}
ES_LOGS_BACKEND_PASSWORD={ES_PASS}
ES_LOGS_BACKEND_PROTOCOL={https or http}- Start the Operator service:
systemctl start opster-operator
K8S
- Download installation file:
wget --no-check-certificate --no-proxy https://opster-k8-helm.s3.amazonaws.com/helm/opster-operator_1.0-b111dd1.tar.gz
- Run:
tar -xvf opster-operator_1.0-b111dd1.tar.gz cd helm-operator
- Fill the values.yaml with respective Environment variables:
SERVICE_PORT={PORT}
VISUALIZATION_URL={URL}
ES_CLUSTERS={JSON_ARRAY}
ES_BACKEND={https or=“” http=“”}://{ES_HOST}:{ES_PORT}
ES_BACKEND_USER={ES_USER}
ES_BACKEND_PASSWORD={ES_PASS}
ES_LOGS_BACKEND: {ES_HOST}
ES_LOGS_BACKEND_PORT: {ES_PORT}
ES_LOGS_BACKEND_PROTOCOL: {https or http}
ES_LOGS_BACKEND_USER: {ES_USER}
ES_LOGS_BACKEND_PASSWORD: {ES_PASS}- Run:
helm upgrade --install operator . -n {NAMESPACE} -f values.yamlDocker
- Run:
docker run -p {SERVICE_PORT}:{SERVICE_PORT} -it -d -e ES_BACKEND={https or=“” http=“”}://{ES_HOST}:{ES_PORT} \
-e VISUALIZATION_URL={URL} \
-e ES_CLUSTERS={JSON_ARRAY} \
-e ES_BACKEND_USER={ES_BACKEND_USER} \
-e ES_BACKEND_PASSWORD={ES_PASS} \
-e ES_LOGS_BACKEND={ES_HOST} \
-e ES_LOGS_BACKEND_PORT={ES_PORT} \
-e ES_LOGS_BACKEND_PROTOCOL={http or https} \
-e ES_LOGS_BACKEND_USER={ES_USER} \
-e ES_LOGS_BACKEND_PASSWORD={ES_PASS} \
--restart always --name operator public.ecr.aws/opsterio/operator:v1.2.22Debian
- Download installation file:
wget --no-check-certificate --no-proxy https://opster-deb.s3.amazonaws.com/operator/opster-operator-v1.2.22.deb
- Run:
dpkg -i opster-operator-v1.2.22.deb
- Fill the /opt/opster/operator/configs/opster_operator.env file with respective values:
SERVICE_PORT={PORT}
VISUALIZATION_URL={URL}
ES_CLUSTERS={JSON_ARRAY} // See example below
ES_BACKEND={https or=“” http=“”}://{ES_HOST}:{ES_PORT}
ES_BACKEND_USER={ES_USER}
ES_BACKEND_PASSWORD={ES_PASS}
ES_LOGS_BACKEND={ES_HOST}
ES_LOGS_BACKEND_PORT={ES_PORT}
ES_LOGS_BACKEND_USER={ES_USER}
ES_LOGS_BACKEND_PASSWORD={ES_PASS}
ES_LOGS_BACKEND_PROTOCOL={https or http}- Start the Operator service:
systemctl start opster-operator
Kibana Dashboard
- The dashboard can be found on Kibana:
- Connect to Kibana.
- Click on
on the left upper side of Kibana Home page.
- In the menu, click on Dashboard/Operator dashboard.
Configuration options
{p}
| Variable Name | Description | Default | Mandatory | Example |
|---|---|---|---|---|
| SERVICE_PORT | Rest server port number where the Operator accepts HTTP requests | 5530 | False | |
| VISUALIZATION_URL | The kibana/Dashboard URL where the logs are saved | True | ||
| VISUALIZATION_USER | The user to use in case visualization is protected by basic authentication | False | ||
| VISUALIZATION_PASSWORD | The password to use in case visualization is protected by basic authentication | False | ||
| ES_BACKEND | The cluster to store .operator index with jobs, statuses, history, etc. Can be separate from clusters targeted for operations | True | http://localhost:9200 | |
| ES_BACKEND_USER | The user to use in case Elasticsearch is protected by basic authentication | |||
| ES_BACKEND_PASSWORD | The password to use in case Elasticsearch is protected by basic authentication | |||
| ES_CLUSTERS | The Elasticsearch clusters the Operator should execute jobs on. | Empty | False | [{ "id" : 2, "url": "http://localhost:9200", "authInfo": { "type": "BASIC" "credentials": { "user": "user1", "password": "userPass1" } } }, { "id" : 3, "url": "http://localhost:9201", "authInfo": { "type": "BASIC", "credentials": { "user": "user2", "password": "userPass2" } } } ] |
| ES_LOGS_BACKEND | The cluster host to store the Operator logs | True | Es.logs, can be also the same cluster as ES_BACKEND (use only the host here) | |
| ES_LOGS_BACKEND_PORT | The port the logs server is listening on | True | ||
| ES_LOGS_BACKEND_PROTOCOL | Http or Https | True | ||
| ES_LOGS_BACKEND_USER | The user to use in case Elasticsearch is protected by basic authentication | False | ||
| ES_LOGS_BACKEND_PASSWORD | The password to use if Elasticsearch is protected by basic authentication | False | ||
| CLIENT_READ_TIMEOUT | The read timeout config to use for the client the Operator uses to communicate with the Elasticsearch cluster | 120000 | False | |
| CLIENT_CONN_TIMEOUT | The connection timeout config to use for the client the Operator uses to communicate with the Elasticsearch cluster | 30000 | False | |
| CLIENT_MAX_CONNECTIONS | The max connections config to use for the client the Operator uses to communicate with the Elasticsearch cluster | 30 | False |