Morio | Morio
Morio is not ready for production|Learn more

Morio

Settings overview

Showing all 226 keys

Required

Settings that governs Morio cluster formation.

Show Example
cluster
YAML - cluster
cluster:
  common:
    name: Morio production cluster
    fqdn: morio.tokyo.morio.it
  broker:
    nodes:
      - broker1.tokyo.morio.it
      - broker2.tokyo.morio.it
      - broker3.tokyo.morio.it
    fqdn: brokers.tokyo.morio.it
  flanking:
    nodes:
      - flanking1.tokyo.morio.it
      - flanking2.tokyo.morio.it

Optional

Settings that apply to all cluster nodes.

Show Example
cluster.common
YAML - cluster.common
cluster:
  common:
    name: Morio production cluster
    fqdn: morio.tokyo.morio.it

Optional

A name for the Morio deployment. Will be used in the generated X.509 certificates.

Show Example
cluster.common.name
YAML - cluster.common.name
cluster:
  common:
    name: Morio production cluster

Optional

The domain name for the entire cluster. When set, it must resolve to a round-robin DNS record that includes all cluster nodes.

Show Example
cluster.common.fqdn
YAML - cluster.common.fqdn
cluster:
  common:
    fqdn: morio.tokyo.morio.it

Required

Settings that apply to broker nodes.

Show Example
cluster.broker
YAML - cluster.broker
cluster:
  broker:
    nodes:
      - broker1.tokyo.morio.it
      - broker2.tokyo.morio.it
      - broker3.tokyo.morio.it
    fqdn: brokers.tokyo.morio.it

Required
Array entries:

The list of broker nodes. This must hold an odd amount of entries to avoid split-brain scenarios. Also note that you cannot (currently) scale the amount of broker nodes after deployment, so choose carefully.

Show Example
cluster.broker.nodes
YAML - cluster.broker.nodes
cluster:
  broker:
    nodes:
      - broker1.tokyo.morio.it
      - broker2.tokyo.morio.it
      - broker3.tokyo.morio.it

The domain name for broker nodes of the cluster. When set, it must point to a round-robin DNS record that includes all broker nodes. This is only mandatory when there are multiple brokers.

Show Example
cluster.broker.fqdn
YAML - cluster.broker.fqdn
cluster:
  broker:
    fqdn: brokers.tokyo.morio.it

Optional

Settings that apply to flanking nodes.

Show Example
cluster.flanking
YAML - cluster.flanking
cluster:
  flanking:
    nodes:
      - flanking1.tokyo.morio.it
      - flanking2.tokyo.morio.it

Optional
Array entries:

The list of flanking nodes. Unlike broker nodes, there is no requirement to have an odd amount of entries.

Show Example
cluster.flanking.nodes
YAML - cluster.flanking.nodes
cluster:
  flanking:
    nodes:
      - flanking1.tokyo.morio.it
      - flanking2.tokyo.morio.it

Optional

Holds settings about data sources and integrations external to Morio.

Show Example
external
YAML - external
external:
  seed:
    git:
      git-id:
        url: https://codeberg.org/certeu/moriohub.git
    modules:
      - glob: git:modules/**@git-id
    processors:
      - glob: git:modules/**@git-id
    charts:
      - glob: git:modules/**@git-id
    sigma:
      fields:
        - glob: git:modules/**@git-id
      rules:
        - glob: git:modules/**@git-id
      subs:
        - glob: git:modules/**@git-id
  vault:
    url: https://vault.tokyo.morio.it
    jwt_auth_path: morio
    kv_path: kv
    role: morio
    verify_certificate: true

Optional

Controls seeding of external content inside Morio.

Show Example
external.seed
YAML - external.seed
external:
  seed:
    git:
      git-id:
        url: https://codeberg.org/certeu/moriohub.git
    modules:
      - glob: git:modules/**@git-id
    processors:
      - glob: git:modules/**@git-id
    charts:
      - glob: git:modules/**@git-id
    sigma:
      fields:
        - glob: git:modules/**@git-id
      rules:
        - glob: git:modules/**@git-id
      subs:
        - glob: git:modules/**@git-id

Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

A list of seed globs from which to load visualisation logic for Morio's UI service.

Show Example
external.seed.charts
YAML - external.seed.charts
external:
  seed:
    charts:
      - glob: git:modules/**@git-id

Required

A git repository to seed content from.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use git-id as a placeholder key to illustrate this.

Show Example
external.seed.git
YAML - external.seed.git
external:
  seed:
    git:
      git-id:
        url: https://codeberg.org/certeu/moriohub.git

Required

A git repository to seed content from.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use git-id as a placeholder key to illustrate this.

Show Example
external.seed.git.git-id
YAML - external.seed.git.git-id
external:
  seed:
    git:
      git-id:
        url: https://codeberg.org/certeu/moriohub.git

Required

The URL to use. Note that we do not support cloning over SSH.

Show Example
external.seed.git.git-id.url
YAML - external.seed.git.git-id.url
external:
  seed:
    git:
      git-id:
        url: https://codeberg.org/certeu/moriohub.git

Optional

The git branch/tag/ref to use. When this is not set, it will default to the value of MORIO_VERSION_TAG.

Optional

The username to use for authentication to the git host.

Optional

The password to use for authentication to the git host.

Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

A list of seed globs from which to load Morio client modules.

Show Example
external.seed.modules
YAML - external.seed.modules
external:
  seed:
    modules:
      - glob: git:modules/**@git-id

Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

A list of seed globs from which to load stream processing logic for Morio's Tap service.

Show Example
external.seed.processors
YAML - external.seed.processors
external:
  seed:
    processors:
      - glob: git:modules/**@git-id

Optional

Controls seeding of Sigma rules, fields, and subs to transform them into stream processing detection logic.

Show Example
external.seed.sigma
YAML - external.seed.sigma
external:
  seed:
    sigma:
      fields:
        - glob: git:modules/**@git-id
      rules:
        - glob: git:modules/**@git-id
      subs:
        - glob: git:modules/**@git-id

Required
Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

Field mappings for Sigma rules inside Morio

Show Example
external.seed.sigma.fields
YAML - external.seed.sigma.fields
external:
  seed:
    sigma:
      fields:
        - glob: git:modules/**@git-id

Required
Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

Sigma rules to seed

Show Example
external.seed.sigma.rules
YAML - external.seed.sigma.rules
external:
  seed:
    sigma:
      rules:
        - glob: git:modules/**@git-id

Required
Array entries:
  • [entry].glob:
    Required
  • [entry].root:
    Optional

Matches Morio stream processor subscriptions to Sigma rules

Show Example
external.seed.sigma.subs
YAML - external.seed.sigma.subs
external:
  seed:
    sigma:
      subs:
        - glob: git:modules/**@git-id

Optional

Hold configuration for integrating Morio with Hashicorp Vault (or OpenBao).

Show Example
external.vault
YAML - external.vault
external:
  vault:
    url: https://vault.tokyo.morio.it
    jwt_auth_path: morio
    kv_path: kv
    role: morio
    verify_certificate: true

Required

The URL of your Vault instance.

Show Example
external.vault.url
YAML - external.vault.url
external:
  vault:
    url: https://vault.tokyo.morio.it

Whether or not to verify the Vault TLS certificate.

Show Example
external.vault.verify_certificate
YAML - external.vault.verify_certificate
external:
  vault:
    verify_certificate: true

The role to assume for authentication to Vault.

Show Example
external.vault.role
YAML - external.vault.role
external:
  vault:
    role: morio

The path under which the JWT authentication method is anchored in Vault.

Show Example
external.vault.jwt_auth_path
YAML - external.vault.jwt_auth_path
external:
  vault:
    jwt_auth_path: morio

The path under which the Key/Value secret store anchored in Vault.

Show Example
external.vault.kv_path
YAML - external.vault.kv_path
external:
  vault:
    kv_path: kv

Optional

Holds the Identity and Access Management (IAM) settings

Show Example
iam
YAML - iam
iam:
  policy:
    rule-id:
      when:
        label: oidc/freesewing/group/users
        method: GET
        provider: freesewing
        user:
          is_not: skully
        role:
          or:
            - user
            - manager
        url:
          or:
            - startsWith: /-/api/cache/glob/check%7C
            - startsWith: /-/api/inventory/hostnames/*
            - startsWith: /-/api/cache/keys/check%7C
      then: allow
  providers:
    apikey: {}
    ldap-provider-id:
      provider: ldap
      about: On-prem Active Directory
      server:
        url: ldaps://dc1.tokyo.morio.it
        bindDN: CN=morio-test,OU=Functional,OU=MORIO,DC=tokyo,DC=morio,DC=it
        bindCredentials: '{|{ AD_PASSWORD }|}'
        searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it
        searchFilter: (&(objectClass=user)(samaccountname={{username}}))
      username_field: samaccountname
      label: Active Directory
      rbac:
        user:
          attribute: samaccountname
          regex: .
        engineer:
          attribute: samaccountname
          list:
            - aaswartz
            - iamurdock
            - deritchie
      verify_certificate: true
      trust_certificate: -----BEGIN CERTIFICATE----- ...
    local: {}
    oidc-provider-id:
      provider: oidc
      label: FreeSewing Account
      about: Sign in with any FreeSewing account
      issuer: https:// backend.freesewing.eu
      client_secret: '{|{ MORIO_SSO_CLIENT_SECRET }|}'
      client_id: morio
      username_field: preferred_username
      rbac:
        user:
          attribute: preferred_username
          regex: .
        engineer:
          attribute: preferred_username
          list:
            - joost
      autodiscovery_url: https://backend.freesewing.eu/.well-known/openid-configuration
      token_endpoint_auth_method: client_secret_basic
      label_attributes:
        email: email
        name: name
        role: role
        username: preferred_username
        uuid: sub

Optional

Holds the various rules that make up the attribute-based access control (ABAC) policy. Refer to the Morio Access Policy Guide for details.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use rule-id as a placeholder key to illustrate this.

Show Example
iam.policy
YAML - iam.policy
iam:
  policy:
    rule-id:
      when:
        label: oidc/freesewing/group/users
        method: GET
        provider: freesewing
        user:
          is_not: skully
        role:
          or:
            - user
            - manager
        url:
          or:
            - startsWith: /-/api/cache/glob/check%7C
            - startsWith: /-/api/inventory/hostnames/*
            - startsWith: /-/api/cache/keys/check%7C
      then: allow

Optional

Holds the various rules that make up the attribute-based access control (ABAC) policy. Refer to the Morio Access Policy Guide for details.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use rule-id as a placeholder key to illustrate this.

Show Example
iam.policy.rule-id
YAML - iam.policy.rule-id
iam:
  policy:
    rule-id:
      when:
        label: oidc/freesewing/group/users
        method: GET
        provider: freesewing
        user:
          is_not: skully
        role:
          or:
            - user
            - manager
        url:
          or:
            - startsWith: /-/api/cache/glob/check%7C
            - startsWith: /-/api/inventory/hostnames/*
            - startsWith: /-/api/cache/keys/check%7C
      then: allow

Required

The matching logic of the access policy rule. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when
YAML - iam.policy.rule-id.when
iam:
  policy:
    rule-id:
      when:
        label: oidc/freesewing/group/users
        method: GET
        provider: freesewing
        user:
          is_not: skully
        role:
          or:
            - user
            - manager
        url:
          or:
            - startsWith: /-/api/cache/glob/check%7C
            - startsWith: /-/api/inventory/hostnames/*
            - startsWith: /-/api/cache/keys/check%7C

Allows matching against labels on the user account. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.label
YAML - iam.policy.rule-id.when.label
iam:
  policy:
    rule-id:
      when:
        label: oidc/freesewing/group/users

Allows matching against the HTTP method (use UPPERCASE). Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.method
YAML - iam.policy.rule-id.when.method
iam:
  policy:
    rule-id:
      when:
        method: GET

Allows matching against the RBAC role assigned to the account. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.role
YAML - iam.policy.rule-id.when.role
iam:
  policy:
    rule-id:
      when:
        role:
          or:
            - user
            - manager

Allows matching against the ID of the identity provider used to authenticate. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.provider
YAML - iam.policy.rule-id.when.provider
iam:
  policy:
    rule-id:
      when:
        provider: freesewing

Allows matching against the request URL. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.url
YAML - iam.policy.rule-id.when.url
iam:
  policy:
    rule-id:
      when:
        url:
          or:
            - startsWith: /-/api/cache/glob/check%7C
            - startsWith: /-/api/inventory/hostnames/*
            - startsWith: /-/api/cache/keys/check%7C

Allows matching against the username. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.when.user
YAML - iam.policy.rule-id.when.user
iam:
  policy:
    rule-id:
      when:
        user:
          is_not: skully

Required

Whether to allow or deny requests that match this rule. Refer to the Morio Access Policy Guide for details.

Show Example
iam.policy.rule-id.then
YAML - iam.policy.rule-id.then
iam:
  policy:
    rule-id:
      then: allow

Optional

Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.

Show Example
iam.providers
YAML - iam.providers
iam:
  providers:
    apikey: {}
    ldap-provider-id:
      provider: ldap
      about: On-prem Active Directory
      server:
        url: ldaps://dc1.tokyo.morio.it
        bindDN: CN=morio-test,OU=Functional,OU=MORIO,DC=tokyo,DC=morio,DC=it
        bindCredentials: '{|{ AD_PASSWORD }|}'
        searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it
        searchFilter: (&(objectClass=user)(samaccountname={{username}}))
      username_field: samaccountname
      label: Active Directory
      rbac:
        user:
          attribute: samaccountname
          regex: .
        engineer:
          attribute: samaccountname
          list:
            - aaswartz
            - iamurdock
            - deritchie
      verify_certificate: true
      trust_certificate: -----BEGIN CERTIFICATE----- ...
    local: {}
    oidc-provider-id:
      provider: oidc
      label: FreeSewing Account
      about: Sign in with any FreeSewing account
      issuer: https:// backend.freesewing.eu
      client_secret: '{|{ MORIO_SSO_CLIENT_SECRET }|}'
      client_id: morio
      username_field: preferred_username
      rbac:
        user:
          attribute: preferred_username
          regex: .
        engineer:
          attribute: preferred_username
          list:
            - joost
      autodiscovery_url: https://backend.freesewing.eu/.well-known/openid-configuration
      token_endpoint_auth_method: client_secret_basic
      label_attributes:
        email: email
        name: name
        role: role
        username: preferred_username
        uuid: sub

Optional
Show Example
iam.providers.apikey
YAML - iam.providers.apikey
iam:
  providers:
    apikey: {}

Optional

Holds the provider type, which for this provider must always be apikey

Optional

The label to use for this identity provider in the Morio UI.

Optional

A (brief) description that will be included in the inline help on the Morio login page. When you have multiple identity providers, this can help you clarify the purpose and use-case of each of them to your users.

Optional
Show Example
iam.providers.local
YAML - iam.providers.local
iam:
  providers:
    local: {}

Optional

Holds the provider type, which for this provider must always be local

Optional

The label to use for this identity provider in the Morio UI.

Optional

A (brief) description that will be included in the inline help on the Morio login page. When you have multiple identity providers, this can help you clarify the purpose and use-case of each of them to your users.

Optional

Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.

Show Example
iam.providers.ldap-provider-id
YAML - iam.providers.ldap-provider-id
iam:
  providers:
    ldap-provider-id:
      provider: ldap
      about: On-prem Active Directory
      server:
        url: ldaps://dc1.tokyo.morio.it
        bindDN: CN=morio-test,OU=Functional,OU=MORIO,DC=tokyo,DC=morio,DC=it
        bindCredentials: '{|{ AD_PASSWORD }|}'
        searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it
        searchFilter: (&(objectClass=user)(samaccountname={{username}}))
      username_field: samaccountname
      label: Active Directory
      rbac:
        user:
          attribute: samaccountname
          regex: .
        engineer:
          attribute: samaccountname
          list:
            - aaswartz
            - iamurdock
            - deritchie
      verify_certificate: true
      trust_certificate: -----BEGIN CERTIFICATE----- ...

Required

Holds the provider type, which for this provider must always be ldap

Show Example
iam.providers.ldap-provider-id.provider
YAML - iam.providers.ldap-provider-id.provider
iam:
  providers:
    ldap-provider-id:
      provider: ldap

Required

The label to use for this identity provider in the Morio UI.

Show Example
iam.providers.ldap-provider-id.label
YAML - iam.providers.ldap-provider-id.label
iam:
  providers:
    ldap-provider-id:
      label: Active Directory

Optional

A (brief) description that will be included in the inline help on the Morio login page. When you have multiple identity providers, this can help you clarify the purpose and use-case of each of them to your users.

Show Example
iam.providers.ldap-provider-id.about
YAML - iam.providers.ldap-provider-id.about
iam:
  providers:
    ldap-provider-id:
      about: On-prem Active Directory

Required

The LDAP field to use for the username within Morio.

Show Example
iam.providers.ldap-provider-id.username_field
YAML - iam.providers.ldap-provider-id.username_field
iam:
  providers:
    ldap-provider-id:
      username_field: samaccountname

Optional

A PEM-encoded certificate to trust for TLS connections.

Show Example
iam.providers.ldap-provider-id.trust_certificate
YAML - iam.providers.ldap-provider-id.trust_certificate
iam:
  providers:
    ldap-provider-id:
      trust_certificate: -----BEGIN CERTIFICATE----- ...

Whether to verify the certificate when establishing the TLS connection or not.

Show Example
iam.providers.ldap-provider-id.verify_certificate
YAML - iam.providers.ldap-provider-id.verify_certificate
iam:
  providers:
    ldap-provider-id:
      verify_certificate: true

Settings to configure the LDAP server.

Show Example
iam.providers.ldap-provider-id.server
YAML - iam.providers.ldap-provider-id.server
iam:
  providers:
    ldap-provider-id:
      server:
        url: ldaps://dc1.tokyo.morio.it
        bindDN: CN=morio-test,OU=Functional,OU=MORIO,DC=tokyo,DC=morio,DC=it
        bindCredentials: '{|{ AD_PASSWORD }|}'
        searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it
        searchFilter: (&(objectClass=user)(samaccountname={{username}}))

Required

The URI to connect to the LDAP server

Show Example
iam.providers.ldap-provider-id.server.url
YAML - iam.providers.ldap-provider-id.server.url
iam:
  providers:
    ldap-provider-id:
      server:
        url: ldaps://dc1.tokyo.morio.it

Optional

The distinguished name (DN) with which to bind to the LDAP server.
Many LDAP servers do not allow anonymous searches. In such a case we need an account to bind to the server so we can find the user. Only then can we attempt to authenticate as the user to verify the credentials.

Show Example
iam.providers.ldap-provider-id.server.bindDN
YAML - iam.providers.ldap-provider-id.server.bindDN
iam:
  providers:
    ldap-provider-id:
      server:
        bindDN: CN=morio-test,OU=Functional,OU=MORIO,DC=tokyo,DC=morio,DC=it

Optional

The credentials that go with the bind DN.

Show Example
iam.providers.ldap-provider-id.server.bindCredentials
YAML - iam.providers.ldap-provider-id.server.bindCredentials
iam:
  providers:
    ldap-provider-id:
      server:
        bindCredentials: '{|{ AD_PASSWORD }|}'

Required

The base under which to search for users who authenticate.

Show Example
iam.providers.ldap-provider-id.server.searchBase
YAML - iam.providers.ldap-provider-id.server.searchBase
iam:
  providers:
    ldap-provider-id:
      server:
        searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it

Optional

The search filter. Typically used to filter out user accounts from other LDAP objects.

Show Example
iam.providers.ldap-provider-id.server.searchFilter
YAML - iam.providers.ldap-provider-id.server.searchFilter
iam:
  providers:
    ldap-provider-id:
      server:
        searchFilter: (&(objectClass=user)(samaccountname={{username}}))

Controls what Morio roles to assign to users authenticating through this identity provider.

Show Example
iam.providers.ldap-provider-id.rbac
YAML - iam.providers.ldap-provider-id.rbac
iam:
  providers:
    ldap-provider-id:
      rbac:
        user:
          attribute: samaccountname
          regex: .
        engineer:
          attribute: samaccountname
          list:
            - aaswartz
            - iamurdock
            - deritchie

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Show Example
iam.providers.ldap-provider-id.rbac.user
YAML - iam.providers.ldap-provider-id.rbac.user
iam:
  providers:
    ldap-provider-id:
      rbac:
        user:
          attribute: samaccountname
          regex: .

Required

The attribute to use from the identity provider.

Show Example
iam.providers.ldap-provider-id.rbac.user.attribute
YAML - iam.providers.ldap-provider-id.rbac.user.attribute
iam:
  providers:
    ldap-provider-id:
      rbac:
        user:
          attribute: samaccountname

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Show Example
iam.providers.ldap-provider-id.rbac.user.regex
YAML - iam.providers.ldap-provider-id.rbac.user.regex
iam:
  providers:
    ldap-provider-id:
      rbac:
        user:
          regex: .

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Required

The attribute to use from the identity provider.

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Required

The attribute to use from the identity provider.

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Show Example
iam.providers.ldap-provider-id.rbac.engineer
YAML - iam.providers.ldap-provider-id.rbac.engineer
iam:
  providers:
    ldap-provider-id:
      rbac:
        engineer:
          attribute: samaccountname
          list:
            - aaswartz
            - iamurdock
            - deritchie

Required

The attribute to use from the identity provider.

Show Example
iam.providers.ldap-provider-id.rbac.engineer.attribute
YAML - iam.providers.ldap-provider-id.rbac.engineer.attribute
iam:
  providers:
    ldap-provider-id:
      rbac:
        engineer:
          attribute: samaccountname

Array entries:

A hard-coded list of attribute values to match.

Show Example
iam.providers.ldap-provider-id.rbac.engineer.list
YAML - iam.providers.ldap-provider-id.rbac.engineer.list
iam:
  providers:
    ldap-provider-id:
      rbac:
        engineer:
          list:
            - aaswartz
            - iamurdock
            - deritchie

A regular expression to match against the attribute value.

Controls adding labels to the user account based on attributes provided by the identity provider. You can use these labels in the Morio ABAC access policy, thus allowing you to implement access control based on group membership and so on.

Validation rules
For each entry:
  • Key: The Morio label name
  • Value: The identity provider label name

Controls adding labels to the user account based on attributes provided by the identity provider. You can use these labels in the Morio ABAC access policy, thus allowing you to implement access control based on group membership and so on.

Validation rules
For each entry:
  • Key: The Morio label name
  • Value: The identity provider label name

Optional

Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.

Show Example
iam.providers.oidc-provider-id
YAML - iam.providers.oidc-provider-id
iam:
  providers:
    oidc-provider-id:
      provider: oidc
      label: FreeSewing Account
      about: Sign in with any FreeSewing account
      issuer: https:// backend.freesewing.eu
      client_secret: '{|{ MORIO_SSO_CLIENT_SECRET }|}'
      client_id: morio
      username_field: preferred_username
      rbac:
        user:
          attribute: preferred_username
          regex: .
        engineer:
          attribute: preferred_username
          list:
            - joost
      autodiscovery_url: https://backend.freesewing.eu/.well-known/openid-configuration
      token_endpoint_auth_method: client_secret_basic
      label_attributes:
        email: email
        name: name
        role: role
        username: preferred_username
        uuid: sub

Required

Holds the provider type, which for this provider must always be ldap

Show Example
iam.providers.oidc-provider-id.provider
YAML - iam.providers.oidc-provider-id.provider
iam:
  providers:
    oidc-provider-id:
      provider: oidc

Required

The label to use for this identity provider in the Morio UI.

Show Example
iam.providers.oidc-provider-id.label
YAML - iam.providers.oidc-provider-id.label
iam:
  providers:
    oidc-provider-id:
      label: FreeSewing Account

Optional

A (brief) description that will be included in the inline help on the Morio login page. When you have multiple identity providers, this can help you clarify the purpose and use-case of each of them to your users.

Show Example
iam.providers.oidc-provider-id.about
YAML - iam.providers.oidc-provider-id.about
iam:
  providers:
    oidc-provider-id:
      about: Sign in with any FreeSewing account

Required

The base URL of your identitity provider.

Show Example
iam.providers.oidc-provider-id.issuer
YAML - iam.providers.oidc-provider-id.issuer
iam:
  providers:
    oidc-provider-id:
      issuer: https:// backend.freesewing.eu

Required

The client secret to exchange with the identity provider.

Show Example
iam.providers.oidc-provider-id.client_secret
YAML - iam.providers.oidc-provider-id.client_secret
iam:
  providers:
    oidc-provider-id:
      client_secret: '{|{ MORIO_SSO_CLIENT_SECRET }|}'

Required

The client ID as configured on the identity provider.

Show Example
iam.providers.oidc-provider-id.client_id
YAML - iam.providers.oidc-provider-id.client_id
iam:
  providers:
    oidc-provider-id:
      client_id: morio

Required

The LDAP field to use for the username within Morio.

Show Example
iam.providers.oidc-provider-id.username_field
YAML - iam.providers.oidc-provider-id.username_field
iam:
  providers:
    oidc-provider-id:
      username_field: preferred_username

Optional

The exact autodiscovery URL. Typically, you do not need to configure this as it can be determined from the issuer setting. However, for OIDC identity providers that implement multi-tenancy, or when using multiple realms, the URL path is often different from the default, and in such a case you can specify the exact path here.

Show Example
iam.providers.oidc-provider-id.autodiscovery_url
YAML - iam.providers.oidc-provider-id.autodiscovery_url
iam:
  providers:
    oidc-provider-id:
      autodiscovery_url: https://backend.freesewing.eu/.well-known/openid-configuration

Optional

Controls how the client proves its identity to the identity provider.

Show Example
iam.providers.oidc-provider-id.token_endpoint_auth_method
YAML - iam.providers.oidc-provider-id.token_endpoint_auth_method
iam:
  providers:
    oidc-provider-id:
      token_endpoint_auth_method: client_secret_basic

Optional

A PEM-encoded certificate to trust for TLS connections.

Whether to verify the certificate when establishing the TLS connection or not.

Controls what Morio roles to assign to users authenticating through this identity provider.

Show Example
iam.providers.oidc-provider-id.rbac
YAML - iam.providers.oidc-provider-id.rbac
iam:
  providers:
    oidc-provider-id:
      rbac:
        user:
          attribute: preferred_username
          regex: .
        engineer:
          attribute: preferred_username
          list:
            - joost

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Show Example
iam.providers.oidc-provider-id.rbac.user
YAML - iam.providers.oidc-provider-id.rbac.user
iam:
  providers:
    oidc-provider-id:
      rbac:
        user:
          attribute: preferred_username
          regex: .

Required

The attribute to use from the identity provider.

Show Example
iam.providers.oidc-provider-id.rbac.user.attribute
YAML - iam.providers.oidc-provider-id.rbac.user.attribute
iam:
  providers:
    oidc-provider-id:
      rbac:
        user:
          attribute: preferred_username

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Show Example
iam.providers.oidc-provider-id.rbac.user.regex
YAML - iam.providers.oidc-provider-id.rbac.user.regex
iam:
  providers:
    oidc-provider-id:
      rbac:
        user:
          regex: .

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Required

The attribute to use from the identity provider.

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Required

The attribute to use from the identity provider.

Array entries:

A hard-coded list of attribute values to match.

A regular expression to match against the attribute value.

Controls which users get assigned this role by matching an attribute from the identity provider. Note that you can use either list or regex but not both.

Show Example
iam.providers.oidc-provider-id.rbac.engineer
YAML - iam.providers.oidc-provider-id.rbac.engineer
iam:
  providers:
    oidc-provider-id:
      rbac:
        engineer:
          attribute: preferred_username
          list:
            - joost

Required

The attribute to use from the identity provider.

Show Example
iam.providers.oidc-provider-id.rbac.engineer.attribute
YAML - iam.providers.oidc-provider-id.rbac.engineer.attribute
iam:
  providers:
    oidc-provider-id:
      rbac:
        engineer:
          attribute: preferred_username

Array entries:

A hard-coded list of attribute values to match.

Show Example
iam.providers.oidc-provider-id.rbac.engineer.list
YAML - iam.providers.oidc-provider-id.rbac.engineer.list
iam:
  providers:
    oidc-provider-id:
      rbac:
        engineer:
          list:
            - joost

A regular expression to match against the attribute value.

Controls adding labels to the user account based on attributes provided by the identity provider. You can use these labels in the Morio ABAC access policy, thus allowing you to implement access control based on group membership and so on.

Validation rules
For each entry:
  • Key: The Morio label name
  • Value: The identity provider label name
Show Example
iam.providers.oidc-provider-id.label_attributes
YAML - iam.providers.oidc-provider-id.label_attributes
iam:
  providers:
    oidc-provider-id:
      label_attributes:
        email: email
        name: name
        role: role
        username: preferred_username
        uuid: sub

Controls adding labels to the user account based on attributes provided by the identity provider. You can use these labels in the Morio ABAC access policy, thus allowing you to implement access control based on group membership and so on.

Validation rules
For each entry:
  • Key: The Morio label name
  • Value: The identity provider label name

Optional

Optional

This setting is required when not doing a setup via the API/UI but instead from settings on disk, and when you have multiple cluster nodes. Morio needs to know which cluster node it is, an uses this setting for that. Note that this should be specific to the local node, and thus different on each cluster node.

Optional

Settings for individual Morio services.

Show Example
services
YAML - services
services:
  all:
    env:
      TEST: EXAMPLE
      FOO: bar
      bar: FOO
  api:
    cors:
      origins:
        - https://some-app.corp.morio.it
        - http://localhost:3000
    env:
      some: var
  broker:
    env:
      some: var
  ca:
    env:
      some: var
  cache:
    instances:
      single:
        env:
          some: var
        max_memory_gb: 1.25
        nodes:
          - flanking1.morio.it
  connector:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt
  console:
    env:
      some: var
  db:
    env:
      some: var
  eda:
    instances:
      eda-id:
        description: EdA instance for the support team
        nodes:
          - flanking1.morio.it
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000
  proxy:
    env:
      some: var
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it
  snmptraps:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
        snmptrapd_custom: >-
          # SNMP v3 auth

          createUser -e 0x80000009030000000000 morio sha-256 {|{
          SNMP_AUTH_PASSWORD }|} aes-128 {|{ SNMP_PRIV_PASSWORD }|}
  tap:
    instances:
      single:
        env:
          some: var
        threads: 4
        max_memory_mb: 1250
        nodes:
          - flanking1.morio.it
  ui:
    env:
      some: var
    iam:
      roles:
        labels:
          user: Staff
          manager: Team Leader
          operator: Operations
          engineer: Morio Core Team
          root: MVDP-mode
  watcher:
    instances:
      single:
        env:
          some: var
        ping_inventory: true
        ca_list:
          - CERT
        monitors:
          icmp-example:
            type: icmp
            name: Ping some hosts
            hosts:
              - host1.morio.it
              - host2.morio.it
          tcp-example:
            type: tcp
            name: Check some ports
            hosts:
              - host1.morio.it
              - host2.morio.it
            ports:
              - 1212
              - 3434
            check:
              send: foo
              receive: bar
          http-example:
            type: http
            name: Test some URLs
            hosts:
              - https://host1.morio.it
              - https://host2.morio.it
            max_redirects: 2
            username: foo
            password: bar
            check:
              request:
                method: GET
                headers:
                  X-Foo-bar: Affirmative
                body: hi
              response:
                status: 200
                headers:
                  X-Foo-bar: Affirmative
                body:
                  - looks
                  - good

Optional

Settings that apply to all services spawned by core (they do not apply to the core service itself).

Show Example
services.all
YAML - services.all
services:
  all:
    env:
      TEST: EXAMPLE
      FOO: bar
      bar: FOO

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.all.env
YAML - services.all.env
services:
  all:
    env:
      TEST: EXAMPLE
      FOO: bar
      bar: FOO

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the API service

Show Example
services.api
YAML - services.api
services:
  api:
    cors:
      origins:
        - https://some-app.corp.morio.it
        - http://localhost:3000
    env:
      some: var

Optional

Allow configuration of the CORS headers returned by this service.

Show Example
services.api.cors
YAML - services.api.cors
services:
  api:
    cors:
      origins:
        - https://some-app.corp.morio.it
        - http://localhost:3000

Array entries:

A list of origins to add to the CORS headers.

Show Example
services.api.cors.origins
YAML - services.api.cors.origins
services:
  api:
    cors:
      origins:
        - https://some-app.corp.morio.it
        - http://localhost:3000

Optional

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.api.env
YAML - services.api.env
services:
  api:
    env:
      some: var

Optional

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the Broker service

Show Example
services.broker
YAML - services.broker
services:
  broker:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.broker.env
YAML - services.broker.env
services:
  broker:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the CA service

Show Example
services.ca
YAML - services.ca
services:
  ca:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.ca.env
YAML - services.ca.env
services:
  ca:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the Cache service

Show Example
services.cache
YAML - services.cache
services:
  cache:
    instances:
      single:
        env:
          some: var
        max_memory_gb: 1.25
        nodes:
          - flanking1.morio.it

Optional

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The cache service only allows a single instance.

Show Example
services.cache.instances
YAML - services.cache.instances
services:
  cache:
    instances:
      single:
        env:
          some: var
        max_memory_gb: 1.25
        nodes:
          - flanking1.morio.it

Settings for the single instance of the Cache service.

Show Example
services.cache.instances.single
YAML - services.cache.instances.single
services:
  cache:
    instances:
      single:
        env:
          some: var
        max_memory_gb: 1.25
        nodes:
          - flanking1.morio.it

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.cache.instances.single.env
YAML - services.cache.instances.single.env
services:
  cache:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

The maximum memory to allocate to the cache in Gigabytes. When the limit is reached, caching will be impacted and keys will be evicted using the volatile-lfu eviction policy.

Show Example
services.cache.instances.single.max_memory_gb
YAML - services.cache.instances.single.max_memory_gb
services:
  cache:
    instances:
      single:
        max_memory_gb: 1.25

Required
Array entries:

The nodes to run the cache service on. Only one node is allowed. Array entries must be one of the cluster nodes.

Show Example
services.cache.instances.single.nodes
YAML - services.cache.instances.single.nodes
services:
  cache:
    instances:
      single:
        nodes:
          - flanking1.morio.it

Optional

Settings that apply to the Connector service

Show Example
services.connector
YAML - services.connector
services:
  connector:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt

Optional

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The Connector service allows only a single instance, but you can run it on multiple nodes.

Show Example
services.connector.instances
YAML - services.connector.instances
services:
  connector:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt

Settings for the single instance of the Connector service.

Show Example
services.connector.instances.single
YAML - services.connector.instances.single
services:
  connector:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.connector.instances.single.env
YAML - services.connector.instances.single.env
services:
  connector:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Required
Array entries:

The nodes to run the cache service on.

Show Example
services.connector.instances.single.nodes
YAML - services.connector.instances.single.nodes
services:
  connector:
    instances:
      single:
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it

Show Example
services.connector.instances.single.vector
YAML - services.connector.instances.single.vector
services:
  connector:
    instances:
      single:
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt

Required

A Vector source configuration. Refer to the Vector Sinks reference.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use source-id as a placeholder key to illustrate this.

Show Example
services.connector.instances.single.vector.sources
YAML - services.connector.instances.single.vector.sources
services:
  connector:
    instances:
      single:
        vector:
          sources:
            source-id:
              type: local_morio
              topics:
                - logs

Optional

A Vector transform configuration. Refer to the Vector Transforms reference.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use transform-id as a placeholder key to illustrate this.

Show Example
services.connector.instances.single.vector.transforms
YAML - services.connector.instances.single.vector.transforms
services:
  connector:
    instances:
      single:
        vector:
          transforms:
            transform-id:
              type: remap
              inputs:
                - source-id
              source: |-
                parsed_message = parse_json!(.message)
                . = parsed_message

Required

The Vector sinks configuration. Refer to the Vector Sinks reference.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use sink-id as a placeholder key to illustrate this.

Show Example
services.connector.instances.single.vector.sinks
YAML - services.connector.instances.single.vector.sinks
services:
  connector:
    instances:
      single:
        vector:
          sinks:
            sink-id:
              type: elasticsearch
              inputs:
                - transform-id
              api_version: auto
              compression: none
              endpoints:
                - https://elasticsearch.tokyo.morio.it
              auth:
                user: '{|{ ELASTIC_INGESTION_USER }|}'
                password: '{|{  ELASTIC_INGESTION_PASSWORD }|}'
                strategy: basic
              mode: bulk
              bulk:
                action: create
                index: logs-{{ .morio.module }}-morio.tokyo
                template_fallback_index: logs-fallback-morio.tokyo
              tls:
                ca_file: /etc/vector/internal-ca.crt

Optional

Settings that apply to the Console service

Show Example
services.console
YAML - services.console
services:
  console:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.console.env
YAML - services.console.env
services:
  console:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the DB service

Show Example
services.db
YAML - services.db
services:
  db:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.db.env
YAML - services.db.env
services:
  db:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the EdA service

Show Example
services.eda
YAML - services.eda
services:
  eda:
    instances:
      eda-id:
        description: EdA instance for the support team
        nodes:
          - flanking1.morio.it
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000

Required

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The EdA service does allow multiple instances, but does not support running a single instance on multiple nodes.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use eda-id as a placeholder key to illustrate this.

Show Example
services.eda.instances
YAML - services.eda.instances
services:
  eda:
    instances:
      eda-id:
        description: EdA instance for the support team
        nodes:
          - flanking1.morio.it
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000

Required

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The EdA service does allow multiple instances, but does not support running a single instance on multiple nodes.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use eda-id as a placeholder key to illustrate this.

Show Example
services.eda.instances.eda-id
YAML - services.eda.instances.eda-id
services:
  eda:
    instances:
      eda-id:
        description: EdA instance for the support team
        nodes:
          - flanking1.morio.it
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000

Required
Array entries:

The cluster node to run this instance on.

Show Example
services.eda.instances.eda-id.nodes
YAML - services.eda.instances.eda-id.nodes
services:
  eda:
    instances:
      eda-id:
        nodes:
          - flanking1.morio.it

A description for this EdA instance.

Show Example
services.eda.instances.eda-id.description
YAML - services.eda.instances.eda-id.description
services:
  eda:
    instances:
      eda-id:
        description: EdA instance for the support team

Optional

Allow configuration of the CORS headers returned by this service.

Show Example
services.eda.instances.eda-id.cors
YAML - services.eda.instances.eda-id.cors
services:
  eda:
    instances:
      eda-id:
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000

Array entries:

A list of origins to add to the CORS headers.

Show Example
services.eda.instances.eda-id.cors.origins
YAML - services.eda.instances.eda-id.cors.origins
services:
  eda:
    instances:
      eda-id:
        cors:
          origins:
            - https://diy.support.corp.morio.it
            - http://localhost:3000

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the Proxy service

Show Example
services.proxy
YAML - services.proxy
services:
  proxy:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.proxy.env
YAML - services.proxy.env
services:
  proxy:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that apply to the SNMPProxy service

Show Example
services.snmpproxy
YAML - services.snmpproxy
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it

Optional

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The SNMPProxy service allows only a single instance, but you can run it on multiple nodes.

Show Example
services.snmpproxy.instances
YAML - services.snmpproxy.instances
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it

Settings for the single SNMPProxy service instance.

Show Example
services.snmpproxy.instances.single
YAML - services.snmpproxy.instances.single
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'
        env:
          some: var
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it

Required
Array entries:

The list of cluster nodes to run this service on.

Show Example
services.snmpproxy.instances.single.nodes
YAML - services.snmpproxy.instances.single.nodes
services:
  snmpproxy:
    instances:
      single:
        nodes:
          - flanking1.morio.it
          - flanking2.morio.it

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.snmpproxy.instances.single.env
YAML - services.snmpproxy.instances.single.env
services:
  snmpproxy:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Extra authentication settings to add to the service.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use auths-id as a placeholder key to illustrate this.

Show Example
services.snmpproxy.instances.single.auths
YAML - services.snmpproxy.instances.single.auths
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'

Extra authentication settings to add to the service.

Part of a settings pattern

These settings are part of a settings pattern which allows multiple blocks of these settings to repeat under a different key. In this documentation, we are use auths-id as a placeholder key to illustrate this.

Show Example
services.snmpproxy.instances.single.auths.auths-id
YAML - services.snmpproxy.instances.single.auths.auths-id
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3
            username: morio
            priv_protocol: AES
            auth_protocol: SHA256
            security_level: authPriv
            password: '{|{ SNMP_AUTH_PASSWORD }|}'
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'

The SNMP version to use for the authentication.

Show Example
services.snmpproxy.instances.single.auths.auths-id.version
YAML - services.snmpproxy.instances.single.auths.auths-id.version
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            version: 3

The username to use for the authentication.

Show Example
services.snmpproxy.instances.single.auths.auths-id.username
YAML - services.snmpproxy.instances.single.auths.auths-id.username
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            username: morio

The privacy or encryption algorighm to use for the authentication.

Show Example
services.snmpproxy.instances.single.auths.auths-id.priv_protocol
YAML - services.snmpproxy.instances.single.auths.auths-id.priv_protocol
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            priv_protocol: AES

The algorithm to use to check message integrity and the sender's identity.

Show Example
services.snmpproxy.instances.single.auths.auths-id.auth_protocol
YAML - services.snmpproxy.instances.single.auths.auths-id.auth_protocol
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            auth_protocol: SHA256

The SNMP security level.

Show Example
services.snmpproxy.instances.single.auths.auths-id.security_level
YAML - services.snmpproxy.instances.single.auths.auths-id.security_level
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            security_level: authPriv

The SNMP password for the authentication.

Show Example
services.snmpproxy.instances.single.auths.auths-id.password
YAML - services.snmpproxy.instances.single.auths.auths-id.password
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            password: '{|{ SNMP_AUTH_PASSWORD }|}'

The SNMP password for AuthPriv mode.

Show Example
services.snmpproxy.instances.single.auths.auths-id.priv_password
YAML - services.snmpproxy.instances.single.auths.auths-id.priv_password
services:
  snmpproxy:
    instances:
      single:
        auths:
          auths-id:
            priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'

Optional

Settings that apply to the SNMPTraps service

Show Example
services.snmptraps
YAML - services.snmptraps
services:
  snmptraps:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
        snmptrapd_custom: >-
          # SNMP v3 auth

          createUser -e 0x80000009030000000000 morio sha-256 {|{
          SNMP_AUTH_PASSWORD }|} aes-128 {|{ SNMP_PRIV_PASSWORD }|}

Optional
Show Example
services.snmptraps.instances
YAML - services.snmptraps.instances
services:
  snmptraps:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
        snmptrapd_custom: >-
          # SNMP v3 auth

          createUser -e 0x80000009030000000000 morio sha-256 {|{
          SNMP_AUTH_PASSWORD }|} aes-128 {|{ SNMP_PRIV_PASSWORD }|}

Optional
Show Example
services.snmptraps.instances.single
YAML - services.snmptraps.instances.single
services:
  snmptraps:
    instances:
      single:
        env:
          some: var
        nodes:
          - flanking1.morio.it
        snmptrapd_custom: >-
          # SNMP v3 auth

          createUser -e 0x80000009030000000000 morio sha-256 {|{
          SNMP_AUTH_PASSWORD }|} aes-128 {|{ SNMP_PRIV_PASSWORD }|}

Required
Array entries:

The list of cluster nodes to run this service on.

Show Example
services.snmptraps.instances.single.nodes
YAML - services.snmptraps.instances.single.nodes
services:
  snmptraps:
    instances:
      single:
        nodes:
          - flanking1.morio.it

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.snmptraps.instances.single.env
YAML - services.snmptraps.instances.single.env
services:
  snmptraps:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

This allows you to pass custom confirutation to the snmptrapd daemon.

Show Example
services.snmptraps.instances.single.snmptrapd_custom
YAML - services.snmptraps.instances.single.snmptrapd_custom
services:
  snmptraps:
    instances:
      single:
        snmptrapd_custom: >-
          # SNMP v3 auth

          createUser -e 0x80000009030000000000 morio sha-256 {|{
          SNMP_AUTH_PASSWORD }|} aes-128 {|{ SNMP_PRIV_PASSWORD }|}

Optional

Settings that apply to the Tap service

Show Example
services.tap
YAML - services.tap
services:
  tap:
    instances:
      single:
        env:
          some: var
        threads: 4
        max_memory_mb: 1250
        nodes:
          - flanking1.morio.it

Optional

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The Tap service allows only a single instance, but you can increase its thread count.

Show Example
services.tap.instances
YAML - services.tap.instances
services:
  tap:
    instances:
      single:
        env:
          some: var
        threads: 4
        max_memory_mb: 1250
        nodes:
          - flanking1.morio.it

Settings for the single SNMPProxy service instance.

Show Example
services.tap.instances.single
YAML - services.tap.instances.single
services:
  tap:
    instances:
      single:
        env:
          some: var
        threads: 4
        max_memory_mb: 1250
        nodes:
          - flanking1.morio.it

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.tap.instances.single.env
YAML - services.tap.instances.single.env
services:
  tap:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

The number of threads to run for stream processing. Increasing thread count is the recommended way to increase stream processing throughput.

Show Example
services.tap.instances.single.threads
YAML - services.tap.instances.single.threads
services:
  tap:
    instances:
      single:
        threads: 4

Optional

The per-thread memory limit in Megabytes. When this limit is reached, the thread will be restarted, so setting it too low can cause a crash loop.

Show Example
services.tap.instances.single.max_memory_mb
YAML - services.tap.instances.single.max_memory_mb
services:
  tap:
    instances:
      single:
        max_memory_mb: 1250

Array entries:

The list of cluster nodes to run this service on.

Show Example
services.tap.instances.single.nodes
YAML - services.tap.instances.single.nodes
services:
  tap:
    instances:
      single:
        nodes:
          - flanking1.morio.it

Optional

Settings that apply to the UI service

Show Example
services.ui
YAML - services.ui
services:
  ui:
    env:
      some: var
    iam:
      roles:
        labels:
          user: Staff
          manager: Team Leader
          operator: Operations
          engineer: Morio Core Team
          root: MVDP-mode

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.ui.env
YAML - services.ui.env
services:
  ui:
    env:
      some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Settings that control the display of identity providers and roles on the login screen.

Show Example
services.ui.iam
YAML - services.ui.iam
services:
  ui:
    iam:
      roles:
        labels:
          user: Staff
          manager: Team Leader
          operator: Operations
          engineer: Morio Core Team
          root: MVDP-mode

Array entries:

Validation rules
For each entry:
  • Key:
  • Value:

Validation rules
For each entry:
  • Key:
  • Value:

Optional

Allows you to use different labels for Morio's built-in RBAC roles.

Show Example
services.ui.iam.roles
YAML - services.ui.iam.roles
services:
  ui:
    iam:
      roles:
        labels:
          user: Staff
          manager: Team Leader
          operator: Operations
          engineer: Morio Core Team
          root: MVDP-mode

Optional

The labels to use for Morio's built-in RBAC roles.

Show Example
services.ui.iam.roles.labels
YAML - services.ui.iam.roles.labels
services:
  ui:
    iam:
      roles:
        labels:
          user: Staff
          manager: Team Leader
          operator: Operations
          engineer: Morio Core Team
          root: MVDP-mode

The label to use for the built-in user role.

Show Example
services.ui.iam.roles.labels.user
YAML - services.ui.iam.roles.labels.user
services:
  ui:
    iam:
      roles:
        labels:
          user: Staff

The label to use for the built-in manager role.

Show Example
services.ui.iam.roles.labels.manager
YAML - services.ui.iam.roles.labels.manager
services:
  ui:
    iam:
      roles:
        labels:
          manager: Team Leader

The label to use for the built-in operator role.

Show Example
services.ui.iam.roles.labels.operator
YAML - services.ui.iam.roles.labels.operator
services:
  ui:
    iam:
      roles:
        labels:
          operator: Operations

The label to use for the built-in engineer role.

Show Example
services.ui.iam.roles.labels.engineer
YAML - services.ui.iam.roles.labels.engineer
services:
  ui:
    iam:
      roles:
        labels:
          engineer: Morio Core Team

The label to use for the built-in root role.

Show Example
services.ui.iam.roles.labels.root
YAML - services.ui.iam.roles.labels.root
services:
  ui:
    iam:
      roles:
        labels:
          root: MVDP-mode

Optional

Settings that apply to the Watcher service

Show Example
services.watcher
YAML - services.watcher
services:
  watcher:
    instances:
      single:
        env:
          some: var
        ping_inventory: true
        ca_list:
          - CERT
        monitors:
          icmp-example:
            type: icmp
            name: Ping some hosts
            hosts:
              - host1.morio.it
              - host2.morio.it
          tcp-example:
            type: tcp
            name: Check some ports
            hosts:
              - host1.morio.it
              - host2.morio.it
            ports:
              - 1212
              - 3434
            check:
              send: foo
              receive: bar
          http-example:
            type: http
            name: Test some URLs
            hosts:
              - https://host1.morio.it
              - https://host2.morio.it
            max_redirects: 2
            username: foo
            password: bar
            check:
              request:
                method: GET
                headers:
                  X-Foo-bar: Affirmative
                body: hi
              response:
                status: 200
                headers:
                  X-Foo-bar: Affirmative
                body:
                  - looks
                  - good

Optional

For consistency, all flanking services are configured through a instances key like this that can hold multiple services instances. However, not all services support multiple instances.
The Watcher service allows only a single instance, but you can run it on multiple nodes.

Show Example
services.watcher.instances
YAML - services.watcher.instances
services:
  watcher:
    instances:
      single:
        env:
          some: var
        ping_inventory: true
        ca_list:
          - CERT
        monitors:
          icmp-example:
            type: icmp
            name: Ping some hosts
            hosts:
              - host1.morio.it
              - host2.morio.it
          tcp-example:
            type: tcp
            name: Check some ports
            hosts:
              - host1.morio.it
              - host2.morio.it
            ports:
              - 1212
              - 3434
            check:
              send: foo
              receive: bar
          http-example:
            type: http
            name: Test some URLs
            hosts:
              - https://host1.morio.it
              - https://host2.morio.it
            max_redirects: 2
            username: foo
            password: bar
            check:
              request:
                method: GET
                headers:
                  X-Foo-bar: Affirmative
                body: hi
              response:
                status: 200
                headers:
                  X-Foo-bar: Affirmative
                body:
                  - looks
                  - good

Settings for the single instance of the Watcher service.

Show Example
services.watcher.instances.single
YAML - services.watcher.instances.single
services:
  watcher:
    instances:
      single:
        env:
          some: var
        ping_inventory: true
        ca_list:
          - CERT
        monitors:
          icmp-example:
            type: icmp
            name: Ping some hosts
            hosts:
              - host1.morio.it
              - host2.morio.it
          tcp-example:
            type: tcp
            name: Check some ports
            hosts:
              - host1.morio.it
              - host2.morio.it
            ports:
              - 1212
              - 3434
            check:
              send: foo
              receive: bar
          http-example:
            type: http
            name: Test some URLs
            hosts:
              - https://host1.morio.it
              - https://host2.morio.it
            max_redirects: 2
            username: foo
            password: bar
            check:
              request:
                method: GET
                headers:
                  X-Foo-bar: Affirmative
                body: hi
              response:
                status: 200
                headers:
                  X-Foo-bar: Affirmative
                body:
                  - looks
                  - good

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value
Show Example
services.watcher.instances.single.env
YAML - services.watcher.instances.single.env
services:
  watcher:
    instances:
      single:
        env:
          some: var

A list of environment variables to set on the service container.

Validation rules
For each entry:
  • Key: The environment variable name
  • Value: The environment variable value

Optional

Enable this to run an ICMP healthcheck to all hosts in the inventory/

Show Example
services.watcher.instances.single.ping_inventory
YAML - services.watcher.instances.single.ping_inventory
services:
  watcher:
    instances:
      single:
        ping_inventory: true

Optional
Array entries:

A list of PEM-encoded certificates to add to the trusted CAs when running healthchecks.

Show Example
services.watcher.instances.single.ca_list
YAML - services.watcher.instances.single.ca_list
services:
  watcher:
    instances:
      single:
        ca_list:
          - CERT

Optional

A list of monitors to run. Refer to the Elastic Heartbeat monitors documenation for all details.

Show Example
services.watcher.instances.single.monitors
YAML - services.watcher.instances.single.monitors
services:
  watcher:
    instances:
      single:
        monitors:
          icmp-example:
            type: icmp
            name: Ping some hosts
            hosts:
              - host1.morio.it
              - host2.morio.it
          tcp-example:
            type: tcp
            name: Check some ports
            hosts:
              - host1.morio.it
              - host2.morio.it
            ports:
              - 1212
              - 3434
            check:
              send: foo
              receive: bar
          http-example:
            type: http
            name: Test some URLs
            hosts:
              - https://host1.morio.it
              - https://host2.morio.it
            max_redirects: 2
            username: foo
            password: bar
            check:
              request:
                method: GET
                headers:
                  X-Foo-bar: Affirmative
                body: hi
              response:
                status: 200
                headers:
                  X-Foo-bar: Affirmative
                body:
                  - looks
                  - good

Array entries:

The list of cluster nodes to run this service on.

Holds feature flags, vars, and secrets.

Show Example
tokens
YAML - tokens
tokens:
  flags:
    DISABLE_IDP_MRT: true
  secrets:
    SUPER_SECRET_PASSWORD: '{"v":2,"iv":"135364debdaff520eb9ed97e","ct":"08744465c41a5e0753","tag":"e02fbc19428f1ea00a6bab109944b3eb"}'
  vars:
    KEEP_SETTINGS_DRY: with variables

Holds feature flags. Refer to the Feature Flags reference for details.

Show Example
tokens.flags
YAML - tokens.flags
tokens:
  flags:
    DISABLE_IDP_MRT: true

Show Example
tokens.secrets
YAML - tokens.secrets
tokens:
  secrets:
    SUPER_SECRET_PASSWORD: '{"v":2,"iv":"135364debdaff520eb9ed97e","ct":"08744465c41a5e0753","tag":"e02fbc19428f1ea00a6bab109944b3eb"}'

Optional

Holds variables that you can re-use inside your settings.

Validation rules
For each entry:
  • Key:
  • Value:
Show Example
tokens.vars
YAML - tokens.vars
tokens:
  vars:
    KEEP_SETTINGS_DRY: with variables

Optional

Holds variables that you can re-use inside your settings.

Validation rules
For each entry:
  • Key:
  • Value:
<!-- Morio wordmark font is phosphate (with some tweaks -->by CERT-EU