Struct CoreConfig

pub struct CoreConfig {

    pub title: String,
    pub host: String,
    pub port: u16,
    pub passkey: String,
    pub ui_write_disabled: bool,
    pub ensure_server: String,
    pub mongo: MongoConfig,
    pub local_auth: bool,
    pub transparent_mode: bool,
    pub enable_new_users: bool,
    pub jwt_secret: String,
    pub jwt_ttl: Timelength,
    pub google_oauth: OauthCredentials,
    pub github_oauth: OauthCredentials,
    pub webhook_secret: String,
    pub webhook_base_url: Option<String>,
    pub github_webhook_app: GithubWebhookAppConfig,
    pub logging: LogConfig,
    pub keep_stats_for_days: u64,
    pub keep_alerts_for_days: u64,
    pub stack_poll_interval: Timelength,
    pub sync_poll_interval: Timelength,
    pub build_poll_interval: Timelength,
    pub repo_poll_interval: Timelength,
    pub monitoring_interval: Timelength,
    pub aws: AwsCredentials,
    pub hetzner: HetznerCredentials,
    pub git_providers: Vec<GitProvider>,
    pub docker_registries: Vec<DockerRegistry>,
    pub aws_ecr_registries: Vec<AwsEcrConfigWithCredentials>,
    pub secrets: HashMap<String, String>,
    pub repo_directory: PathBuf,
}

Core Configuration File

The Core API initializes it’s configuration by reading the environment, parsing the CoreConfig schema from the file path specified by env.monitor_config_path, and then applying any config field overrides specified in the environment.

Note. The monitor core docker image includes the default core configuration found below. To configure the core api, you can either mount your own custom configuration file to /config/config.toml inside the container, or simply override whichever fields you need using the environment.

Refer to the example file for a full example.

Fields

title: String

The title of this monitor deployment. Will be used in the browser page title. Default: ‘Monitor’

host: String

The host to use with oauth redirect url, whatever host the user hits to access monitor. eg https://monitor.mogh.tech. Only used if oauth used without user specifying redirect url themselves.

port: u16

Port the core web server runs on. Default: 9120.

passkey: String

Sent in auth header with req to periphery. Should be some secure hash, maybe 20-40 chars.

ui_write_disabled: bool

Disable user ability to use the UI to update resource configuration.

ensure_server: String

If defined, ensure an enabled server exists at this address. Use with All In One compose. Example: http://monitor-periphery:8120

mongo: MongoConfig

Configure core mongo connection.

An easy deployment method is to use Mongo Atlas to provide a reliable database.

local_auth: bool

enable login with local auth

transparent_mode: bool

Enable transparent mode, which gives all (enabled) users read access to all resources.

enable_new_users: bool

New users will be automatically enabled. Combined with transparent mode, this is suitable for a demo instance.

jwt_secret: String

Optionally provide a specific jwt secret. Passing nothing or an empty string will cause one to be generated. Default: “” (empty string)

jwt_ttl: Timelength

Control how long distributed JWT remain valid for. Default: 1-day.

google_oauth: OauthCredentials

Configure google oauth

github_oauth: OauthCredentials

Configure github oauth

webhook_secret: String

Used to verify validity from webhooks. Should be some secure hash maybe 20-40 chars. It is given to git provider when configuring the webhook.

webhook_base_url: Option<String>

Override the webhook listener base url, if None will use the address defined as ‘host’. Example: https://webhooks.mogh.tech

This can be used if core sits on an internal network which is unreachable directly from the open internet. A reverse proxy in a public network can forward webhooks to the internal monitor.

github_webhook_app: GithubWebhookAppConfig

Configure a Github Webhook app. Allows users to manage repo webhooks from within the Monitor UI.

logging: LogConfig

Configure logging

keep_stats_for_days: u64

Number of days to keep stats, or 0 to disable pruning. Stats older than this number of days are deleted on a daily cycle Default: 14

keep_alerts_for_days: u64

Number of days to keep alerts, or 0 to disable pruning. Alerts older than this number of days are deleted on a daily cycle Default: 14

stack_poll_interval: Timelength

Interval at which to poll stacks for any updates / automated actions. Options: 15-sec, 1-min, 5-min, 15-min, 1-hr Default: 5-min.

sync_poll_interval: Timelength

Interval at which to poll syncs for any updates / automated actions. Options: 15-sec, 1-min, 5-min, 15-min, 1-hr Default: 5-min.

build_poll_interval: Timelength

Interval at which to poll build commit hash for any updates / automated actions. Options: 15-sec, 1-min, 5-min, 15-min, 1-hr Default: 5-min.

repo_poll_interval: Timelength

Interval at which to poll repo commit hash for any updates / automated actions. Options: 15-sec, 1-min, 5-min, 15-min, 1-hr Default: 5-min.

monitoring_interval: Timelength

Interval at which to collect server stats and send any alerts. Default: 15-sec

aws: AwsCredentials

Configure AWS credentials to use with AWS builds / server launches.

hetzner: HetznerCredentials

Configure Hetzner credentials to use with Hetzner builds / server launches.

git_providers: Vec<GitProvider>

Configure git credentials used to clone private repos. Supports any git provider.

docker_registries: Vec<DockerRegistry>

Configure docker credentials used to push / pull images. Supports any docker image repository.

aws_ecr_registries: Vec<AwsEcrConfigWithCredentials>

Configure aws ecr registries, which are handled differently than other registries

secrets: HashMap<String, String>

Configure core-based secrets. These will be preferentially interpolated into values if they contain a matching secret. Otherwise, the periphery will have to have the secret configured.

repo_directory: PathBuf

Specify the directory used to clone stack / repo / build repos, for latest hash / contents. The default is fine when using a container. This directory has no need for persistence, so no need to mount it. Default: /repos

Implementations

impl CoreConfig

pub fn sanitized(&self) -> CoreConfig

Trait Implementations

impl Clone for CoreConfig

fn clone(&self) -> CoreConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CoreConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CoreConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CoreConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.