Skip to content

Latest commit

 

History

History
79 lines (68 loc) · 6.24 KB

installation.org

File metadata and controls

79 lines (68 loc) · 6.24 KB

Installation

NOTE: Bullseye’s server is not able to start without running database. As a result backend restarts a few times before db is ready. In addition, there is no initial configuration provided on startup. The reason is a potential risk of overriding existing configuration provided by a user. This may cause incorrect tables in database errors in logs.

Docker

  1. Configure Enterprise Commerce and MQTT URLs in docker-compose
  2. docker-compose up -f deployments/docker-compose.yml

To dockerize Bullseye run make dockerize. You only have to do this if you modified code, or if default image ceased to exist.

Environmental variables

All of those modify only bullseye’s server behaviour. MQTT must match Raspberry Pi configuration.

NameDefaultDescription
EC_HOST_APIhttps://localhost:9002/rest/v2URL to host which serves EC OCC v2 REST API.
EC_HOST_STATIChttps://localhost:9002URL to base EC host.
EC_PRODUCTS_SITEelectronicsName of the products site to access.
EC_HTTP_CLIENT_TIMEOUT_SECONDS10Amount of time to wait before cancelling request.
SERVER_PORT8080The port on which the HTTP server listens.
SERVER_IP0.0.0.0IP of the server.
SERVER_LOGGER_TYPE3Type of used logger.
DB_HOSTlocalhostDatabase host name.
DB_PORT5432Database server port.
DB_USERpostgresUser’s name.
DB_PASSWORDpasswordUser’s password.
DB_NAMEpostgresDatabase name.
DB_DRIVERpostgresDatabase driver name.
HW_MQTT_BROKERtcp://test.mosquitto.org:1883Default MQTT server.
HW_MQTT_KEEPALIVE_SECONDS2Keep-alive time.
HW_MQTT_TIMEOUT_SECONDS2Timeout for commands.
HW_MQTT_DISCONNECT_MILLISECONDS250Disconnect time.

Kyma

In order install Bullseye on cluster use a helm chart located in ./chart/bullseye/. Use helm chart’s values to configure bullseye. They are listed in a section below. Parameters should be passed to helm the following way:

--set "variable1=value1","variable2=value2",...,"variablen=valuen"

Make sure to pass appropriate values for “release name” and “namespace name” not to override deployed application version in scope of given namespace.

helm dependency update deployments/chart/bullseye --tls
helm install deployments/chart/bullseye -n {release name} --namespace {namespace name} --set "kyma.cluster.hostname={cluster URL}","ec.url={URL to EC instance}","backend.image={name}","frontend.image={name}","mqtt.image=eclipse-mosquitto" --tls

The helm chart contains both backend and frontend.

values

All URLs must not have trailing slashes.

ParameterDefaultDescription
ec.urlhttps://localhost:9002URL to EC instance.
ec.api/rest/v2Prefix to access EC API.
ec.siteelectronicsBase site for accessing web resources from EC.
kyma.cluster.hostnamekyma.localURL of your cluster (mainly for exposing API).
kyma.cluster.internalsvc.cluster.localInternal URL of cluster.
backend.subdomainbackendName of backend subdomain (used to expose API).
backend.imagenoneImage of backend application.
frontend.subdomainbullseyeName of frontend subdomain (used to expose API).
frontend.imagenoneImage of frontend application.
mqtt.subdomainmqtt-brokerName of broker subdomain (used to expose API).
mqtt.imagenoneImage of MQTT broker application.
mqtt.port31400Exposed port to communicate with broker.
mqtt.gateway.namegatewayName of MQTT broker gateway.
postgres.postgresqlUsernamepostgresPostgreSQL database username.
postgres.postgresqlPasswordpasswordPostgreSQL database password.