Operator Installation

Quick links:

RPM

  • Run:
rpm -ivh https://opster-rpms.s3.amazonaws.com/operator/opster-operator-v1.2.11.noarch.rpm
  • Fill the /opt/opster/operator/configs/opster_operator.env file with respective values:
SERVICE_PORT=
VISUALIZATION_URL=
ES_CLUSTERS=
ES_URL=://:
ES_USER=
ES_PASSWORD=
ES_LOGS_BACKEND=
ES_LOGS_BACKEND_PORT=
ES_LOGS_BACKEND_USER=
ES_LOGS_BACKEND_PASSWORD=
ES_LOGS_BACKEND_PROTOCOL=
  • 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-a3658af.tar.gz
  • Run:
tar -xvf opster-operator_1.0-a3658af.tar.gz
cd opster-operator
  • Fill the values.yaml with respective Environment variables:
SERVICE_PORT=
  VISUALIZATION_URL=
  ES_CLUSTERS=
  ES_URL=://:
  ES_USER=
  ES_PASSWORD=
  ES_LOGS_BACKEND: 
  ES_LOGS_BACKEND_PORT: 
  ES_LOGS_BACKEND_PROTOCOL: 
  ES_LOGS_BACKEND_USER: 
  ES_LOGS_BACKEND_PASSWORD: 
  • Run:
helm upgrade --install . operator -n  -f values.yaml

Docker

  • Run:
docker run -p : -it -d -e ES_URL=https://: \
-e VISUALIZATION_URL= \
-e ES_CLUSTERS= \ 
-e ES_USER= \
-e ES_PASSWORD= \
-e ES_LOGS_BACKEND= \
-e ES_LOGS_BACKEND_PORT= \
-e ES_LOGS_BACKEND_PROTOCOL= \
-e ES_LOGS_BACKEND_USER= \
-e ES_LOGS_BACKEND_PASSWORD= \
--restart always --name operator public.ecr.aws/opsterio/operator:v1.2.11

Debian

  • Download installation file:
wget --no-check-certificate --no-proxy https://opster-deb.s3.amazonaws.com/operator/opster-operator-v1.2.11.deb
  • Run:
dpkg -i opster-operator-v1.2.11.deb
  • Fill the /opt/opster/operator/configs/opster_operator.env file with respective values:
SERVICE_PORT=
VISUALIZATION_URL=
ES_CLUSTERS= // See example below
ES_URL=://:
ES_USER=
ES_PASSWORD=
ES_LOGS_BACKEND=
ES_LOGS_BACKEND_PORT=
ES_LOGS_BACKEND_USER=
ES_LOGS_BACKEND_PASSWORD=
ES_LOGS_BACKEND_PROTOCOL=
  • Start the Operator service:
systemctl start opster-operator

Kibana Dashboard

  1. 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

Variable NameDescriptionDefaultMandatoryExample
SERVICE_PORTRest server port number where the Operator accepts HTTP requests5530False
VISUALIZATION_URLThe kibana/Dashboard URL where the logs are savedTrue
VISUALIZATION_USERThe user to use in case visualization is protected by basic authenticationFalse
VISUALIZATION_PASSWORDThe password to use in case visualization is protected by basic authenticationFalse
ES_BACKENDThe cluster to store .operator index with jobs, statuses, history, etc. Can be separate from clusters targeted for operationsTruehttp://localhost:9200
ES_BACKEND_USERThe user to use in case Elasticsearch is protected by basic authentication
ES_BACKEND_PASSWORDThe password to use in case Elasticsearch is protected by basic authentication
ES_CLUSTERSThe Elasticsearch clusters the Operator should execute jobs on.EmptyFalse[{
"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_BACKENDThe cluster host to store the Operator logsTrueEs.logs, can be also the same cluster as ES_BACKEND (use only the host here)
ES_LOGS_BACKEND_PORTThe port the logs server is listening onTrue
ES_LOGS_BACKEND_PROTOCOLHttp or HttpsTrue
ES_LOGS_BACKEND_USERThe user to use in case Elasticsearch is protected by basic authenticationFalse
ES_LOGS_BACKEND_PASSWORDThe password to use if Elasticsearch is protected by basic authenticationFalse
CLIENT_READ_TIMEOUTThe read timeout config to use for the client the Operator uses to communicate with the Elasticsearch cluster120000False
CLIENT_CONN_TIMEOUTThe connection timeout config to use for the client the Operator uses to communicate with the Elasticsearch cluster30000False
CLIENT_MAX_CONNECTIONSThe max connections config to use for the client the Operator uses to communicate with the Elasticsearch cluster30False
Skip to content