EDA Deployment =============== The EDA deployment consist of deployment of Configuration Manager Tango Device, Event Subscriber Tango Device,Archwizard, Archviewer and EDA configurator tool. | The Deployment requires TimescaleDB credentials along with some variables to connect with other tools in deployment. | Below table shows mandatory values required by EDA chart while deployment. | These values are present in charts/ska-tango-archiver/values.yaml or can be added in values.yaml. **Note** 1. TimescaleDB credentials to be utilized using CI/CD variable. 2. If the TimescaleDB chart is using vault in certain environment, please make sure to get the value manually and update the latest value in CI/CD variable. 3. Currently(6-10-2023) there is no provision to utilize vault in ska-tango-archiver chart. .. list-table:: Values Required :widths: 15 50 15 15 15 :header-rows: 1 * - Key - description - type - default - vault key required * - hostname - IP address or DNS of TimescaleDB server.This value is optional if the vault is enabled.[v2.10.0] - str - None - PGHOST_MID,PGHOST_LOW * - dbname - Database name for archiving.Will be created if does not exists. - str - default_archiver_db - NA * - dbuser - Database user name.This value is optional if the vault is enabled.[v2.10.0] - str - None - PGUSER_MID,PGUSER_LOW * - port - Port of TimescaleDB server.This value is optional if the vault is enabled.[v2.10.0] - int - None - PGPORT_MID,PGPORT_LOW * - dbpassword - Password of user specified.This value is optional if the vault is enabled.[v2.10.0] - str - None - PGPASSWORD_MID,PGPASSWORD_LOW * - telescope - This variable helps to specify deployment type Low/Mid. - str - SKA-mid - NA * - telescope_environment - This variable is used by EDA Configurator tool to display environment in which tool is deployed. - str - MID-STFC - NA * - archwizard_config - This variable is required by archwizard tool for administration purpose. - str - "MyHDB=tango://tango-databaseds.ska-tango-archiver.svc.cluster.local:10000/mid-eda/cm/01" - NA * - car_sources - This variable is required for auto configuration functionality. The user needs to provide a CAR source where the configuration file is present. - str - "" - NA * - car_file_path - This variable is required for auto configuration functionality.The user needs to provide a CAR file path under source where the configuration file is present . - str - "" - NA * - configuration_file_url - This variable is required for auto configuration functionality.The user needs to provide url of the configuration file. - str - "" - NA * - vaultAddress - vault address details - str - "https://vault.skao.int" - NA * - vault.enabled - Whether vault is required to pass database credentials.Its is necessary for pipeline deployments. - bool - true - NA * - vault.secretPath - Sceret path in vault where values are stored.Example:"dev/data/himalaya/archiver" - str - "" - NA * - vault.secretMount - mount location of vault.Example: dev - str - dev - NA * - pgappname - The application_name can be any string of less than NAMEDATALEN characters (64 characters in a standard build). It is typically set by an application upon connection to the server. The name will be displayed in the pg_stat_activity view and included in CSV log entries. - str - STFC_Archiver - PGAPPNAME_MID,PGAPPNAME_LOW * - api_id - refers to the client ID of the protected API, used in scope when requesting access tokens - str - api://c11afb4b-b5f3-4237-88d8-e9a4425ce1ef(low) api://3fa73b16-53e2-4b70-ab48-80fc7c7ded2c(mid) - NA * - configuration_manager_count - User can provide number of configuration manager needed in the deployment. - int - 1 - NA * - event_subscriber_count - User can provide number of event subscriber needed in the deployment. - int - 1 - NA **Major updates from v2.10.0:** * Improved security,provided support to store the sensitive data (database credentials) into vault.Please refer above table for name of the keys required. * Vault can be disabled for local use, in this case user needs to provide the necessary details via values like before. * Please refer this `link `_ to add secrets into vault. **Details of v2.9.0:** * The support for multiple dabase and servers has been discontinued for sometime. * The variables used for the same are discontinued and updated in user guide. * Archwizard and archviewer are now accesible using the ingress url. * New helm variable "allowed_origins" has been introduced, that can be set to allow the origins to access the archviewer tool using ingress host. Default value: "k8s.stfc.skao.int" Example: .. code-block:: ska-tango-archiver: #chart name allowed_origins: - host1 - host2 **Variables required in v2.7.0:** * configuration_manager : Name of the configuration manager * event_subscriber: Name of event subscriber. * Note: This variables are now discarded in v2.7.1 * To deploy the archiver enter following command: .. code-block:: make k8s-install-chart or can directly provide values to make command as shown below .. code-block:: make k8s-install-chart TELESCOPE= ARCHIVER_DBNAME= ARCHIVER_TIMESCALE_HOST_NAME= ARCHIVER_TIMESCALE_PORT= ARCHIVER_TIMESCALE_DB_USER= ARCHIVER_TIMESCALE_DB_PWD= TELESCOPE_ENVIRONMENT= ARCHWIZARD_CONFIG= * The archiver gets deployed in namespace `ska-tango-archiver` * On gitlab ci-cd Masked Environment variables are created `ARCHIVER_TIMESCALE_DB_PWD` , `ARCHIVER_TIMESCALE_DB_USER` , `ARCHIVER_TIMESCALE_HOST_NAME`, `ARCHIVER_TIMESCALE_PORT` which contains archiver database connection details. * To delete the deployment enter following command: .. code-block:: make k8s-uninstall-chart