Skip to content

Latest commit

 

History

History
113 lines (80 loc) · 8.22 KB

calendar-configuration.md

File metadata and controls

113 lines (80 loc) · 8.22 KB
title categories description weight menu
Calendar configuration
reference
Configuration for the Rhize Calendar Service
900
main
parent identifier
reference-service-config

The Calendar Service handles polling work calendar definitions and generating work calendar entries in the graph and time series databases.

logging

Logs the configuration to the console.

Attributes Description
type Specifies the logging configuration type: json, multi, or console.
(Default: console)
Level Configures the level of logging: Trace, Debug, Info, Warn, Error, Fatal, and Panic.
(Default: Trace)

NATS

Message broker that drives Rhize's event-based architecture.

Attributes Description
SERVER_URL The URL of the NATS server.
(Default: nats://system:system@localhost:4222)

OIDC

Configurations for Keycloak authentication and connection with OpenID Connect.

Attributes Description
serverUrl The URL of the OpenID Connect server.
(Default: http://localhost:8090)
realm Identifies the authentication domain for which the authentication request is being made.
client_id The unique identifier assigned to the client application by the OIDC server.
client_secret Used to authenticate the client when making confidential requests.
username The username credentials of the user who is attempting to authenticate with the OIDC server.
password The password credentials of the user who is attempting to authenticate with the OIDC server.

OpenTelemetry

Attributes Description
serverUrl The URL of the OpenTelemetry server.
(Default: localhost:4317)
samplingRate The sampling rate for traces.
(Default: 1)

libreDataStoreGraphQL

Attribute Description
GRAPHQL_URL The URL of the GraphQL endpoint to use for interacting with Rhize services.
(Default: http://localhost:8080/graphql)

GraphQLSubscriber

Attribute Description
GRAPHQL_URL The URL of the GraphQL endpoint for the GraphQLSubscriber.
(Default: http://localhost:4000/)

RESTAPI

Attribute Description
PORT The port number for RestAPI connection.
(Default: 8080)

Calendar

Specific configuration options for the calendar service.

Attribute Description
QueryIntervalMinutes How often to poll the work calendar definitions
(Default: 10)

QUERY

Query options specific to the calendar service

Attribute Description
hierarchyScopeRecursionDepth How deep to recurse through the hierarchy scope hierarchy
(Default: 3)
equipmentRecursionDepth How deep to recurse through the equipment hierarchy
(Default: 3)

Influx3

InfluxDB3 server options

Attribute Description
Database The name of the database to connect to
(Default: Libre_calendar-service)
Host The host of the Influx3 database
(Default: http://localhost:8096)
Organization The Influx3 Organization (Influx3 Cloud)
(Default: Libre)
TokenPrefix The prefix used in the authorization token (Token for Influx 3 cloud, Bearer for Influx3 Edge)
(Default: Token)
Token The authorization token to attach to any Influx3 requests

Postgres

Postgres server options

Attribute Description
Host The hostname of the Postgres database
(Default: localhost)
Port Those port of the Postgres database
(Default: 5432)
User The Postgres user name
(Default: postgres)
Password The Postgres instance password
(Default: postgres)
Database The database name for the Postgres instance
(Default: Libre)

Database

Which database instance to use, either Postgres or Influx3
(Default: Influx3)