- /
- Documentation
- /
- Reference
- /
- Morio
Morio
Settings overview
- cluster
- cluster.common
- cluster.common.name
- cluster.common.fqdn
- cluster.broker
- cluster.broker.nodes
- cluster.broker.fqdn
- cluster.flanking
- cluster.flanking.nodes
- external
- external.seed
- external.seed.charts
- external.seed.git
- external.seed.git.git-id
- external.seed.git.git-id.url
- external.seed.git.git-id.ref
- external.seed.git.git-id.user
- external.seed.git.git-id.token
- external.seed.modules
- external.seed.processors
- external.seed.sigma
- external.seed.sigma.fields
- external.seed.sigma.rules
- external.seed.sigma.subs
- external.vault
- external.vault.url
- external.vault.verify_certificate
- external.vault.role
- external.vault.jwt_auth_path
- external.vault.kv_path
- iam
- iam.policy
- iam.policy.rule-id
- iam.policy.rule-id.when
- iam.policy.rule-id.when.label
- iam.policy.rule-id.when.method
- iam.policy.rule-id.when.role
- iam.policy.rule-id.when.provider
- iam.policy.rule-id.when.url
- iam.policy.rule-id.when.user
- iam.policy.rule-id.then
- iam.providers
- iam.providers.apikey
- iam.providers.apikey.provider
- iam.providers.apikey.label
- iam.providers.apikey.about
- iam.providers.local
- iam.providers.local.provider
- iam.providers.local.label
- iam.providers.local.about
- iam.providers.ldap-provider-id
- iam.providers.ldap-provider-id.provider
- iam.providers.ldap-provider-id.label
- iam.providers.ldap-provider-id.about
- iam.providers.ldap-provider-id.username_field
- iam.providers.ldap-provider-id.trust_certificate
- iam.providers.ldap-provider-id.verify_certificate
- iam.providers.ldap-provider-id.server
- iam.providers.ldap-provider-id.server.url
- iam.providers.ldap-provider-id.server.bindDN
- iam.providers.ldap-provider-id.server.bindCredentials
- iam.providers.ldap-provider-id.server.searchBase
- iam.providers.ldap-provider-id.server.searchFilter
- iam.providers.ldap-provider-id.rbac
- iam.providers.ldap-provider-id.rbac.user
- iam.providers.ldap-provider-id.rbac.user.attribute
- iam.providers.ldap-provider-id.rbac.user.list
- iam.providers.ldap-provider-id.rbac.user.regex
- iam.providers.ldap-provider-id.rbac.manager
- iam.providers.ldap-provider-id.rbac.manager.attribute
- iam.providers.ldap-provider-id.rbac.manager.list
- iam.providers.ldap-provider-id.rbac.manager.regex
- iam.providers.ldap-provider-id.rbac.operator
- iam.providers.ldap-provider-id.rbac.operator.attribute
- iam.providers.ldap-provider-id.rbac.operator.list
- iam.providers.ldap-provider-id.rbac.operator.regex
- iam.providers.ldap-provider-id.rbac.engineer
- iam.providers.ldap-provider-id.rbac.engineer.attribute
- iam.providers.ldap-provider-id.rbac.engineer.list
- iam.providers.ldap-provider-id.rbac.engineer.regex
- iam.providers.ldap-provider-id.label_attributes
- iam.providers.ldap-provider-id.label_attributes.example-id
- iam.providers.oidc-provider-id
- iam.providers.oidc-provider-id.provider
- iam.providers.oidc-provider-id.label
- iam.providers.oidc-provider-id.about
- iam.providers.oidc-provider-id.issuer
- iam.providers.oidc-provider-id.client_secret
- iam.providers.oidc-provider-id.client_id
- iam.providers.oidc-provider-id.username_field
- iam.providers.oidc-provider-id.autodiscovery_url
- iam.providers.oidc-provider-id.token_endpoint_auth_method
- iam.providers.oidc-provider-id.trust_certificate
- iam.providers.oidc-provider-id.verify_certificate
- iam.providers.oidc-provider-id.rbac
- iam.providers.oidc-provider-id.rbac.user
- iam.providers.oidc-provider-id.rbac.user.attribute
- iam.providers.oidc-provider-id.rbac.user.list
- iam.providers.oidc-provider-id.rbac.user.regex
- iam.providers.oidc-provider-id.rbac.manager
- iam.providers.oidc-provider-id.rbac.manager.attribute
- iam.providers.oidc-provider-id.rbac.manager.list
- iam.providers.oidc-provider-id.rbac.manager.regex
- iam.providers.oidc-provider-id.rbac.operator
- iam.providers.oidc-provider-id.rbac.operator.attribute
- iam.providers.oidc-provider-id.rbac.operator.list
- iam.providers.oidc-provider-id.rbac.operator.regex
- iam.providers.oidc-provider-id.rbac.engineer
- iam.providers.oidc-provider-id.rbac.engineer.attribute
- iam.providers.oidc-provider-id.rbac.engineer.list
- iam.providers.oidc-provider-id.rbac.engineer.regex
- iam.providers.oidc-provider-id.label_attributes
- iam.providers.oidc-provider-id.label_attributes.example-id
- local
- local.fqdn
- services
- services.all
- services.all.env
- services.all.env.example-id
- services.api
- services.api.cors
- services.api.cors.origins
- services.api.env
- services.api.env.example-id
- services.broker
- services.broker.env
- services.broker.env.example-id
- services.ca
- services.ca.env
- services.ca.env.example-id
- services.cache
- services.cache.instances
- services.cache.instances.single
- services.cache.instances.single.env
- services.cache.instances.single.env.example-id
- services.cache.instances.single.max_memory_gb
- services.cache.instances.single.nodes
- services.connector
- services.connector.instances
- services.connector.instances.single
- services.connector.instances.single.env
- services.connector.instances.single.env.example-id
- services.connector.instances.single.nodes
- services.connector.instances.single.vector
- services.connector.instances.single.vector.sources
- services.connector.instances.single.vector.transforms
- services.connector.instances.single.vector.sinks
- services.console
- services.console.env
- services.console.env.example-id
- services.db
- services.db.env
- services.db.env.example-id
- services.eda
- services.eda.instances
- services.eda.instances.eda-id
- services.eda.instances.eda-id.nodes
- services.eda.instances.eda-id.description
- services.eda.instances.eda-id.cors
- services.eda.instances.eda-id.cors.origins
- services.eda.instances.eda-id.env
- services.eda.instances.eda-id.env.example-id
- services.proxy
- services.proxy.env
- services.proxy.env.example-id
- services.snmpproxy
- services.snmpproxy.instances
- services.snmpproxy.instances.single
- services.snmpproxy.instances.single.nodes
- services.snmpproxy.instances.single.env
- services.snmpproxy.instances.single.env.example-id
- services.snmpproxy.instances.single.auths
- services.snmpproxy.instances.single.auths.auths-id
- services.snmpproxy.instances.single.auths.auths-id.version
- services.snmpproxy.instances.single.auths.auths-id.username
- services.snmpproxy.instances.single.auths.auths-id.priv_protocol
- services.snmpproxy.instances.single.auths.auths-id.auth_protocol
- services.snmpproxy.instances.single.auths.auths-id.security_level
- services.snmpproxy.instances.single.auths.auths-id.password
- services.snmpproxy.instances.single.auths.auths-id.priv_password
- services.snmptraps
- services.snmptraps.instances
- services.snmptraps.instances.single
- services.snmptraps.instances.single.nodes
- services.snmptraps.instances.single.env
- services.snmptraps.instances.single.env.example-id
- services.snmptraps.instances.single.snmptrapd_custom
- services.tap
- services.tap.instances
- services.tap.instances.single
- services.tap.instances.single.env
- services.tap.instances.single.env.example-id
- services.tap.instances.single.threads
- services.tap.instances.single.max_memory_mb
- services.tap.instances.single.nodes
- services.ui
- services.ui.env
- services.ui.env.example-id
- services.ui.iam
- services.ui.iam.providers
- services.ui.iam.providers.order
- services.ui.iam.providers.visibility
- services.ui.iam.providers.visibility.example-id
- services.ui.iam.roles
- services.ui.iam.roles.labels
- services.ui.iam.roles.labels.user
- services.ui.iam.roles.labels.manager
- services.ui.iam.roles.labels.operator
- services.ui.iam.roles.labels.engineer
- services.ui.iam.roles.labels.root
- services.watcher
- services.watcher.instances
- services.watcher.instances.single
- services.watcher.instances.single.env
- services.watcher.instances.single.env.example-id
- services.watcher.instances.single.ping_inventory
- services.watcher.instances.single.ca_list
- services.watcher.instances.single.monitors
- services.watcher.instances.single.nodes
- tokens
- tokens.flags
- tokens.secrets
- tokens.secrets.string-example
- tokens.secrets.object-example
- tokens.vars
- tokens.vars.example-id
Showing all 226 keys
Settings that governs Morio cluster formation.
Show Examplecluster
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
Settings that apply to all cluster nodes.
Show Examplecluster.common
cluster:
common:
name: Morio production cluster
fqdn: morio.tokyo.morio.it
A name for the Morio deployment. Will be used in the generated X.509 certificates.
Show Examplecluster.common.name
cluster:
common:
name: Morio production cluster
The domain name for the entire cluster. When set, it must resolve to a round-robin DNS record that includes all cluster nodes.
Show Examplecluster.common.fqdn
cluster:
common:
fqdn: morio.tokyo.morio.it
Settings that apply to broker nodes.
Show Examplecluster.broker
cluster:
broker:
nodes:
- broker1.tokyo.morio.it
- broker2.tokyo.morio.it
- broker3.tokyo.morio.it
fqdn: brokers.tokyo.morio.it
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 Examplecluster.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 Examplecluster.broker.fqdn
cluster:
broker:
fqdn: brokers.tokyo.morio.it
Settings that apply to flanking nodes.
Show Examplecluster.flanking
cluster:
flanking:
nodes:
- flanking1.tokyo.morio.it
- flanking2.tokyo.morio.it
The list of flanking nodes. Unlike broker nodes, there is no requirement to have an odd amount of entries.
Show Examplecluster.flanking.nodes
cluster:
flanking:
nodes:
- flanking1.tokyo.morio.it
- flanking2.tokyo.morio.it
Holds settings about data sources and integrations external to Morio.
Show Exampleexternal
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
Controls seeding of external content inside Morio.
Show Exampleexternal.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
- [entry].glob: Required
- [entry].root: Optional
A list of seed globs from which to load visualisation logic for Morio's UI service.
Show Exampleexternal.seed.charts
external:
seed:
charts:
- glob: git:modules/**@git-id
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 Exampleexternal.seed.git
external:
seed:
git:
git-id:
url: https://codeberg.org/certeu/moriohub.git
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 Exampleexternal.seed.git.git-id
external:
seed:
git:
git-id:
url: https://codeberg.org/certeu/moriohub.git
The URL to use. Note that we do not support cloning over SSH.
Show Exampleexternal.seed.git.git-id.url
external:
seed:
git:
git-id:
url: https://codeberg.org/certeu/moriohub.git
The git branch/tag/ref to use. When this is not set, it will default to the value of MORIO_VERSION_TAG.
- [entry].glob: Required
- [entry].root: Optional
A list of seed globs from which to load Morio client modules.
Show Exampleexternal.seed.modules
external:
seed:
modules:
- glob: git:modules/**@git-id
- [entry].glob: Required
- [entry].root: Optional
A list of seed globs from which to load stream processing logic for Morio's Tap service.
Show Exampleexternal.seed.processors
external:
seed:
processors:
- glob: git:modules/**@git-id
Controls seeding of Sigma rules, fields, and subs to transform them into stream processing detection logic.
Show Exampleexternal.seed.sigma
external:
seed:
sigma:
fields:
- glob: git:modules/**@git-id
rules:
- glob: git:modules/**@git-id
subs:
- glob: git:modules/**@git-id
- [entry].glob: Required
- [entry].root: Optional
Field mappings for Sigma rules inside Morio
Show Exampleexternal.seed.sigma.fields
external:
seed:
sigma:
fields:
- glob: git:modules/**@git-id
- [entry].glob: Required
- [entry].root: Optional
Sigma rules to seed
Show Exampleexternal.seed.sigma.rules
external:
seed:
sigma:
rules:
- glob: git:modules/**@git-id
- [entry].glob: Required
- [entry].root: Optional
Matches Morio stream processor subscriptions to Sigma rules
Show Exampleexternal.seed.sigma.subs
external:
seed:
sigma:
subs:
- glob: git:modules/**@git-id
Hold configuration for integrating Morio with Hashicorp Vault (or OpenBao).
Show Exampleexternal.vault
external:
vault:
url: https://vault.tokyo.morio.it
jwt_auth_path: morio
kv_path: kv
role: morio
verify_certificate: true
The URL of your Vault instance.
Show Exampleexternal.vault.url
external:
vault:
url: https://vault.tokyo.morio.it
Whether or not to verify the Vault TLS certificate.
Show Exampleexternal.vault.verify_certificate
external:
vault:
verify_certificate: true
The role to assume for authentication to Vault.
Show Exampleexternal.vault.role
external:
vault:
role: morio
The path under which the JWT authentication method is anchored in Vault.
Show Exampleexternal.vault.jwt_auth_path
external:
vault:
jwt_auth_path: morio
The path under which the Key/Value secret store anchored in Vault.
Show Exampleexternal.vault.kv_path
external:
vault:
kv_path: kv
Holds the Identity and Access Management (IAM) settings
Show Exampleiam
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
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 Exampleiam.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
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 Exampleiam.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
The matching logic of the access policy rule. Refer to the Morio Access Policy Guide for details.
Show Exampleiam.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 Exampleiam.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 Exampleiam.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 Exampleiam.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 Exampleiam.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 Exampleiam.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 Exampleiam.policy.rule-id.when.user
iam:
policy:
rule-id:
when:
user:
is_not: skully
Whether to allow or deny requests that match this rule. Refer to the Morio Access Policy Guide for details.
Show Exampleiam.policy.rule-id.then
iam:
policy:
rule-id:
then: allow
Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.
Show Exampleiam.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
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.
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.
Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.
Show Exampleiam.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----- ...
Holds the provider type, which for this provider must always be ldap
Show Exampleiam.providers.ldap-provider-id.provider
iam:
providers:
ldap-provider-id:
provider: ldap
The label to use for this identity provider in the Morio UI.
Show Exampleiam.providers.ldap-provider-id.label
iam:
providers:
ldap-provider-id:
label: Active Directory
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 Exampleiam.providers.ldap-provider-id.about
iam:
providers:
ldap-provider-id:
about: On-prem Active Directory
The LDAP field to use for the username within Morio.
Show Exampleiam.providers.ldap-provider-id.username_field
iam:
providers:
ldap-provider-id:
username_field: samaccountname
A PEM-encoded certificate to trust for TLS connections.
Show Exampleiam.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 Exampleiam.providers.ldap-provider-id.verify_certificate
iam:
providers:
ldap-provider-id:
verify_certificate: true
Settings to configure the LDAP server.
Show Exampleiam.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}}))
The URI to connect to the LDAP server
Show Exampleiam.providers.ldap-provider-id.server.url
iam:
providers:
ldap-provider-id:
server:
url: ldaps://dc1.tokyo.morio.it
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 Exampleiam.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
The credentials that go with the bind DN.
Show Exampleiam.providers.ldap-provider-id.server.bindCredentials
iam:
providers:
ldap-provider-id:
server:
bindCredentials: '{|{ AD_PASSWORD }|}'
The base under which to search for users who authenticate.
Show Exampleiam.providers.ldap-provider-id.server.searchBase
iam:
providers:
ldap-provider-id:
server:
searchBase: OU=MORIO,DC=tokyo,DC=morio,DC=it
The search filter. Typically used to filter out user accounts from other LDAP objects.
Show Exampleiam.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 Exampleiam.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 Exampleiam.providers.ldap-provider-id.rbac.user
iam:
providers:
ldap-provider-id:
rbac:
user:
attribute: samaccountname
regex: .
The attribute to use from the identity provider.
Show Exampleiam.providers.ldap-provider-id.rbac.user.attribute
iam:
providers:
ldap-provider-id:
rbac:
user:
attribute: samaccountname
A regular expression to match against the attribute value.
Show Exampleiam.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.
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.
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 Exampleiam.providers.ldap-provider-id.rbac.engineer
iam:
providers:
ldap-provider-id:
rbac:
engineer:
attribute: samaccountname
list:
- aaswartz
- iamurdock
- deritchie
The attribute to use from the identity provider.
Show Exampleiam.providers.ldap-provider-id.rbac.engineer.attribute
iam:
providers:
ldap-provider-id:
rbac:
engineer:
attribute: samaccountname
A hard-coded list of attribute values to match.
Show Exampleiam.providers.ldap-provider-id.rbac.engineer.list
iam:
providers:
ldap-provider-id:
rbac:
engineer:
list:
- aaswartz
- iamurdock
- deritchie
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
- 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
- Key: The Morio label name
- Value: The identity provider label name
Holds identity providers for HTTP-based authentication inside Morio. Refer to the Morio Identity Providers Guide.
Show Exampleiam.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
Holds the provider type, which for this provider must always be ldap
Show Exampleiam.providers.oidc-provider-id.provider
iam:
providers:
oidc-provider-id:
provider: oidc
The label to use for this identity provider in the Morio UI.
Show Exampleiam.providers.oidc-provider-id.label
iam:
providers:
oidc-provider-id:
label: FreeSewing Account
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 Exampleiam.providers.oidc-provider-id.about
iam:
providers:
oidc-provider-id:
about: Sign in with any FreeSewing account
The base URL of your identitity provider.
Show Exampleiam.providers.oidc-provider-id.issuer
iam:
providers:
oidc-provider-id:
issuer: https:// backend.freesewing.eu
The client secret to exchange with the identity provider.
Show Exampleiam.providers.oidc-provider-id.client_secret
iam:
providers:
oidc-provider-id:
client_secret: '{|{ MORIO_SSO_CLIENT_SECRET }|}'
The client ID as configured on the identity provider.
Show Exampleiam.providers.oidc-provider-id.client_id
iam:
providers:
oidc-provider-id:
client_id: morio
The LDAP field to use for the username within Morio.
Show Exampleiam.providers.oidc-provider-id.username_field
iam:
providers:
oidc-provider-id:
username_field: preferred_username
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 Exampleiam.providers.oidc-provider-id.autodiscovery_url
iam:
providers:
oidc-provider-id:
autodiscovery_url: https://backend.freesewing.eu/.well-known/openid-configuration
Controls how the client proves its identity to the identity provider.
Show Exampleiam.providers.oidc-provider-id.token_endpoint_auth_method
iam:
providers:
oidc-provider-id:
token_endpoint_auth_method: client_secret_basic
Controls what Morio roles to assign to users authenticating through this identity provider.
Show Exampleiam.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 Exampleiam.providers.oidc-provider-id.rbac.user
iam:
providers:
oidc-provider-id:
rbac:
user:
attribute: preferred_username
regex: .
The attribute to use from the identity provider.
Show Exampleiam.providers.oidc-provider-id.rbac.user.attribute
iam:
providers:
oidc-provider-id:
rbac:
user:
attribute: preferred_username
A regular expression to match against the attribute value.
Show Exampleiam.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.
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.
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 Exampleiam.providers.oidc-provider-id.rbac.engineer
iam:
providers:
oidc-provider-id:
rbac:
engineer:
attribute: preferred_username
list:
- joost
The attribute to use from the identity provider.
Show Exampleiam.providers.oidc-provider-id.rbac.engineer.attribute
iam:
providers:
oidc-provider-id:
rbac:
engineer:
attribute: preferred_username
A hard-coded list of attribute values to match.
Show Exampleiam.providers.oidc-provider-id.rbac.engineer.list
iam:
providers:
oidc-provider-id:
rbac:
engineer:
list:
- joost
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
- Key: The Morio label name
- Value: The identity provider label name
Show Exampleiam.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
- Key: The Morio label name
- Value: The identity provider label name
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.
Settings for individual Morio services.
Show Exampleservices
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
Settings that apply to all services spawned by core (they do not apply to the core service itself).
Show Exampleservices.all
services:
all:
env:
TEST: EXAMPLE
FOO: bar
bar: FOO
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.all.env
services:
all:
env:
TEST: EXAMPLE
FOO: bar
bar: FOO
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the API service
Show Exampleservices.api
services:
api:
cors:
origins:
- https://some-app.corp.morio.it
- http://localhost:3000
env:
some: var
Allow configuration of the CORS headers returned by this service.
Show Exampleservices.api.cors
services:
api:
cors:
origins:
- https://some-app.corp.morio.it
- http://localhost:3000
A list of origins to add to the CORS headers.
Show Exampleservices.api.cors.origins
services:
api:
cors:
origins:
- https://some-app.corp.morio.it
- http://localhost:3000
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.api.env
services:
api:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the Broker service
Show Exampleservices.broker
services:
broker:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.broker.env
services:
broker:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the CA service
Show Exampleservices.ca
services:
ca:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.ca.env
services:
ca:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the Cache service
Show Exampleservices.cache
services:
cache:
instances:
single:
env:
some: var
max_memory_gb: 1.25
nodes:
- flanking1.morio.it
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 Exampleservices.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 Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.cache.instances.single.env
services:
cache:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
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 Exampleservices.cache.instances.single.max_memory_gb
services:
cache:
instances:
single:
max_memory_gb: 1.25
The nodes to run the cache service on. Only one node is allowed. Array entries must be one of the cluster nodes.
Show Exampleservices.cache.instances.single.nodes
services:
cache:
instances:
single:
nodes:
- flanking1.morio.it
Settings that apply to the Connector service
Show Exampleservices.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
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 Exampleservices.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 Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.connector.instances.single.env
services:
connector:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
The nodes to run the cache service on.
Show Exampleservices.connector.instances.single.nodes
services:
connector:
instances:
single:
nodes:
- flanking1.morio.it
- flanking2.morio.it
Show Exampleservices.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
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 Exampleservices.connector.instances.single.vector.sources
services:
connector:
instances:
single:
vector:
sources:
source-id:
type: local_morio
topics:
- logs
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 Exampleservices.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
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 Exampleservices.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
Settings that apply to the Console service
Show Exampleservices.console
services:
console:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.console.env
services:
console:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the DB service
Show Exampleservices.db
services:
db:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.db.env
services:
db:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the EdA service
Show Exampleservices.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
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 Exampleservices.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
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 Exampleservices.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
The cluster node to run this instance on.
Show Exampleservices.eda.instances.eda-id.nodes
services:
eda:
instances:
eda-id:
nodes:
- flanking1.morio.it
A description for this EdA instance.
Show Exampleservices.eda.instances.eda-id.description
services:
eda:
instances:
eda-id:
description: EdA instance for the support team
Allow configuration of the CORS headers returned by this service.
Show Exampleservices.eda.instances.eda-id.cors
services:
eda:
instances:
eda-id:
cors:
origins:
- https://diy.support.corp.morio.it
- http://localhost:3000
A list of origins to add to the CORS headers.
Show Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the Proxy service
Show Exampleservices.proxy
services:
proxy:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.proxy.env
services:
proxy:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that apply to the SNMPProxy service
Show Exampleservices.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
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 Exampleservices.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 Exampleservices.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
The list of cluster nodes to run this service on.
Show Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.snmpproxy.instances.single.env
services:
snmpproxy:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- 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 Exampleservices.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 Exampleservices.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 Exampleservices.snmpproxy.instances.single.auths.auths-id.version
services:
snmpproxy:
instances:
single:
auths:
auths-id:
version: 3
The username to use for the authentication.
Show Exampleservices.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 Exampleservices.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 Exampleservices.snmpproxy.instances.single.auths.auths-id.auth_protocol
services:
snmpproxy:
instances:
single:
auths:
auths-id:
auth_protocol: SHA256
The SNMP security level.
Show Exampleservices.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 Exampleservices.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 Exampleservices.snmpproxy.instances.single.auths.auths-id.priv_password
services:
snmpproxy:
instances:
single:
auths:
auths-id:
priv_password: '{|{ SNMP_PRIV_PASSWORD }|}'
Settings that apply to the SNMPTraps service
Show Exampleservices.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 }|}
Show Exampleservices.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 }|}
Show Exampleservices.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 }|}
The list of cluster nodes to run this service on.
Show Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.snmptraps.instances.single.env
services:
snmptraps:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
This allows you to pass custom confirutation to the snmptrapd daemon.
Show Exampleservices.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 }|}
Settings that apply to the Tap service
Show Exampleservices.tap
services:
tap:
instances:
single:
env:
some: var
threads: 4
max_memory_mb: 1250
nodes:
- flanking1.morio.it
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 Exampleservices.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 Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.tap.instances.single.env
services:
tap:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
The number of threads to run for stream processing. Increasing thread count is the recommended way to increase stream processing throughput.
Show Exampleservices.tap.instances.single.threads
services:
tap:
instances:
single:
threads: 4
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 Exampleservices.tap.instances.single.max_memory_mb
services:
tap:
instances:
single:
max_memory_mb: 1250
The list of cluster nodes to run this service on.
Show Exampleservices.tap.instances.single.nodes
services:
tap:
instances:
single:
nodes:
- flanking1.morio.it
Settings that apply to the UI service
Show Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.ui.env
services:
ui:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Settings that control the display of identity providers and roles on the login screen.
Show Exampleservices.ui.iam
services:
ui:
iam:
roles:
labels:
user: Staff
manager: Team Leader
operator: Operations
engineer: Morio Core Team
root: MVDP-mode
Allows you to use different labels for Morio's built-in RBAC roles.
Show Exampleservices.ui.iam.roles
services:
ui:
iam:
roles:
labels:
user: Staff
manager: Team Leader
operator: Operations
engineer: Morio Core Team
root: MVDP-mode
The labels to use for Morio's built-in RBAC roles.
Show Exampleservices.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 Exampleservices.ui.iam.roles.labels.user
services:
ui:
iam:
roles:
labels:
user: Staff
The label to use for the built-in manager role.
Show Exampleservices.ui.iam.roles.labels.manager
services:
ui:
iam:
roles:
labels:
manager: Team Leader
The label to use for the built-in operator role.
Show Exampleservices.ui.iam.roles.labels.operator
services:
ui:
iam:
roles:
labels:
operator: Operations
The label to use for the built-in engineer role.
Show Exampleservices.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 Exampleservices.ui.iam.roles.labels.root
services:
ui:
iam:
roles:
labels:
root: MVDP-mode
Settings that apply to the Watcher service
Show Exampleservices.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
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 Exampleservices.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 Exampleservices.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
- Key: The environment variable name
- Value: The environment variable value
Show Exampleservices.watcher.instances.single.env
services:
watcher:
instances:
single:
env:
some: var
A list of environment variables to set on the service container.
Validation rules
- Key: The environment variable name
- Value: The environment variable value
Enable this to run an ICMP healthcheck to all hosts in the inventory/
Show Exampleservices.watcher.instances.single.ping_inventory
services:
watcher:
instances:
single:
ping_inventory: true
A list of PEM-encoded certificates to add to the trusted CAs when running healthchecks.
Show Exampleservices.watcher.instances.single.ca_list
services:
watcher:
instances:
single:
ca_list:
- CERT
A list of monitors to run. Refer to the Elastic Heartbeat monitors documenation for all details.
Show Exampleservices.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
Holds feature flags, vars, and secrets.
Show Exampletokens
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 Exampletokens.flags
tokens:
flags:
DISABLE_IDP_MRT: true
Show Exampletokens.secrets
tokens:
secrets:
SUPER_SECRET_PASSWORD: '{"v":2,"iv":"135364debdaff520eb9ed97e","ct":"08744465c41a5e0753","tag":"e02fbc19428f1ea00a6bab109944b3eb"}'
Holds variables that you can re-use inside your settings.
Validation rules
- Key:
- Value:
Show Exampletokens.vars
tokens:
vars:
KEEP_SETTINGS_DRY: with variables