ThirdEye is available as a managed platform with StarTree Cloud.
It can also be installed from a binary file, from sources or using Docker.
Before you start, read ThirdEye Infrastructure Requirements for details about capacity planning, components, and deployment planning.
StarTree Cloud provides managed hosting for ThirdEye on all major cloud platforms, including AWS and GCP.
To start using ThirdEye in StarTree Cloud, sign up for StarTree Cloud.
StarTree Cloud provides managed hosting for ThirdEye on all major cloud platforms, including AWS and GCP.
To start using ThirdEye in StarTree Cloud, sign up for StarTree Cloud.
To install ThirdEye on Kubernetes using Helm, complete the steps in this doc.
kubectl
is connected to the k8s cluster where you want to install ThirdEyeContact StarTree to obtain credentials to create a k8s secret that lets helm access ThirdEye source files.
Use these to set up access to the Artifactory repo.
To install ThirdEye, complete the follow steps to set up a Helm repo and run the Helm install.
Edit the following script to include your credentials.
Verify the startree-thirdeye
chart is accessible.
Expected Output:
Edit the following script to include your credentials.```
To specify ThirdEye configurations, do one of the following:
--set key=value[,key=value]
arguments to the helm install
command.Alternatively, you can create a YAML file that specifies the values for the parameters, then load it like this:
ThirdEye has plugin infrastructure which lets you to create your own plugins. To avoid creating Secret
resources for the sensitive data for each new plugin, create dynamic secrets. For example, add the following information to a values.yaml
file:
Here are some important details:
Secret
resource is created with data fields corresponding to each entry in secrets
.env
. In the server pods, if we pass env
, smtpUsername
is injected as an environment variable with the variable name SMTP_USER
and value tobefedexternally
, while holidayLoaderKey
won’t be injected as environment variable.encoded: true
, then the value isn’t encoded because Helm assumes the value is already encoded.base64
encoded values to avoid parsing issues.ThirdEye lets you display events from external Google calendars. To enable this feature, provide a base64 encoded JSON key. See https://docs.simplecalendar.io/google-api-key/ for more details.
To install this feature:
The ThirdEye Helm chart has a default list of the following calendars:
But if you want to pass a selected list of calendars, do this:
To enable SSL/TLS on ThirdEye components, contact StarTree.
To configure basic authentication, add the following to your server.yaml
file:
Details
Property | Description |
---|---|
enabled | Flag to enable/disable auth |
basic.enabled | Flag to enable/disable Basic authentication filter |
basic.users[].username | Username for authentication |
basic.users[].password | Password for authentication |
Property | Description |
---|---|
image.repository | Docker repository where ThirdEye server image is present |
image.tag | Docker image tag of ThirdEye server image |
ui.image.repository | Docker repository where ThirdEye UI image is present |
ui.image.tag | Docker image tag of ThirdEye UI image |
ui.port | UI service port |
ui.publicUrl | Url on which ThirdEye UI is exposed publicly. All the notifications will use this url to share the anomaly page link |
scheduler.enabled | Flag to run a separate scheduler. If not enabled then coordinator itself will take care of scheduling tasks |
worker.enabled | Flag to run a separate worker. If not enabled then coordinator itself will take care of running tasks |
worker.replicas | Number of worker pods required |
worker.randomWorkerIdEnabled | Flag to enable assigning random worker ids to worker pods. Must be set true for multiple workers. |
prometheus.enabled | Flag to expose prometheus metrics and adding annotations for prometheus to scrape the metrics |
mysql.enabled | Flag to disable MySQL deployment if using external instance |
mysql.url | Database URL if using external instance |
mysql.port | Database port if using external instance |
mysql.mysqlUser | Database username |
mysql.mysqlPassword | Database password |
mysql.persistence.size | Size of persistent volume created for database storage |
config.jdbcParameters | Config to pass additional parameters to the jdbc connection string |
[coordinator/worker/scheduler].strategy | Specifies the strategy used to replace old Pods by new ones. |
tls.[coordinator/worker/scheduler/ui].secretName | When provided it will override the default secret names referred for tls keys |
The Docker image is not publicly available yet, but you can build it manually.
To be the first to know when public docker images are available, join the StarTree Community slack.
Binaries are not publicly available yet, but you can build from the sources manually.
To be the first to know when public binaries are available, join the StarTree Community slack.
Build | Edition | Version |
---|---|---|
helm chart | Community | 2.6.0 |
thirdeye | Community | 1.199.0 |
thirdeye-ui | Community | 2.41.4 |
startree-thirdeye | Enterprise | 0.154.0 |
ThirdEye is available as a managed platform with StarTree Cloud.
It can also be installed from a binary file, from sources or using Docker.
Before you start, read ThirdEye Infrastructure Requirements for details about capacity planning, components, and deployment planning.
StarTree Cloud provides managed hosting for ThirdEye on all major cloud platforms, including AWS and GCP.
To start using ThirdEye in StarTree Cloud, sign up for StarTree Cloud.
StarTree Cloud provides managed hosting for ThirdEye on all major cloud platforms, including AWS and GCP.
To start using ThirdEye in StarTree Cloud, sign up for StarTree Cloud.
To install ThirdEye on Kubernetes using Helm, complete the steps in this doc.
kubectl
is connected to the k8s cluster where you want to install ThirdEyeContact StarTree to obtain credentials to create a k8s secret that lets helm access ThirdEye source files.
Use these to set up access to the Artifactory repo.
To install ThirdEye, complete the follow steps to set up a Helm repo and run the Helm install.
Edit the following script to include your credentials.
Verify the startree-thirdeye
chart is accessible.
Expected Output:
Edit the following script to include your credentials.```
To specify ThirdEye configurations, do one of the following:
--set key=value[,key=value]
arguments to the helm install
command.Alternatively, you can create a YAML file that specifies the values for the parameters, then load it like this:
ThirdEye has plugin infrastructure which lets you to create your own plugins. To avoid creating Secret
resources for the sensitive data for each new plugin, create dynamic secrets. For example, add the following information to a values.yaml
file:
Here are some important details:
Secret
resource is created with data fields corresponding to each entry in secrets
.env
. In the server pods, if we pass env
, smtpUsername
is injected as an environment variable with the variable name SMTP_USER
and value tobefedexternally
, while holidayLoaderKey
won’t be injected as environment variable.encoded: true
, then the value isn’t encoded because Helm assumes the value is already encoded.base64
encoded values to avoid parsing issues.ThirdEye lets you display events from external Google calendars. To enable this feature, provide a base64 encoded JSON key. See https://docs.simplecalendar.io/google-api-key/ for more details.
To install this feature:
The ThirdEye Helm chart has a default list of the following calendars:
But if you want to pass a selected list of calendars, do this:
To enable SSL/TLS on ThirdEye components, contact StarTree.
To configure basic authentication, add the following to your server.yaml
file:
Details
Property | Description |
---|---|
enabled | Flag to enable/disable auth |
basic.enabled | Flag to enable/disable Basic authentication filter |
basic.users[].username | Username for authentication |
basic.users[].password | Password for authentication |
Property | Description |
---|---|
image.repository | Docker repository where ThirdEye server image is present |
image.tag | Docker image tag of ThirdEye server image |
ui.image.repository | Docker repository where ThirdEye UI image is present |
ui.image.tag | Docker image tag of ThirdEye UI image |
ui.port | UI service port |
ui.publicUrl | Url on which ThirdEye UI is exposed publicly. All the notifications will use this url to share the anomaly page link |
scheduler.enabled | Flag to run a separate scheduler. If not enabled then coordinator itself will take care of scheduling tasks |
worker.enabled | Flag to run a separate worker. If not enabled then coordinator itself will take care of running tasks |
worker.replicas | Number of worker pods required |
worker.randomWorkerIdEnabled | Flag to enable assigning random worker ids to worker pods. Must be set true for multiple workers. |
prometheus.enabled | Flag to expose prometheus metrics and adding annotations for prometheus to scrape the metrics |
mysql.enabled | Flag to disable MySQL deployment if using external instance |
mysql.url | Database URL if using external instance |
mysql.port | Database port if using external instance |
mysql.mysqlUser | Database username |
mysql.mysqlPassword | Database password |
mysql.persistence.size | Size of persistent volume created for database storage |
config.jdbcParameters | Config to pass additional parameters to the jdbc connection string |
[coordinator/worker/scheduler].strategy | Specifies the strategy used to replace old Pods by new ones. |
tls.[coordinator/worker/scheduler/ui].secretName | When provided it will override the default secret names referred for tls keys |
The Docker image is not publicly available yet, but you can build it manually.
To be the first to know when public docker images are available, join the StarTree Community slack.
Binaries are not publicly available yet, but you can build from the sources manually.
To be the first to know when public binaries are available, join the StarTree Community slack.
Build | Edition | Version |
---|---|---|
helm chart | Community | 2.6.0 |
thirdeye | Community | 1.199.0 |
thirdeye-ui | Community | 2.41.4 |
startree-thirdeye | Enterprise | 0.154.0 |