Documentation


name

Name of the app.

app.ocean

Includes information about the Ocean runtime.

  • app.ocean.version

context

Current template context.

  • context.engine.name
  • context.node.main
  • context.node.worker

actions

Actions associated with the app.

  • actions.action_name.label
  • actions.action_name.type
  • actions.action_name.value
  • actions.action_name.default_value
  • actions.action_name.ui
    • actions.action_name.ui.label
    • actions.action_name.ui.toggle
      • actions.action_name.ui.toggle.enabled.button
        • actions.action_name.ui.toggle.enabled.button.label
        • actions.action_name.ui.toggle.enabled.button.url
      • actions.action_name.ui.toggle.disabled.button
        • actions.action_name.ui.toggle.disabled.button.label
        • actions.action_name.ui.toggle.disabled.button.url
  • actions.action_name.setting
    • actions.action_name.setting.description
    • actions.action_name.setting.group
    • actions.action_name.setting.label

workspace

Includes properties of the workspace where the app is installed.

  • workspace.user.name
  • workspace.user.group
  • workspace.user.uid
  • workspace.user.gid
  • workspace.user.keys
    • workspace.user.keys.[].name
    • workspace.user.keys.[].algorithm
    • workspace.user.keys.[].length
    • workspace.user.keys.[].public_key
    • workspace.user.keys.[].ssh_public_key

images

Includes a hash of images.

  • images.image_name.registry
  • images.image_name.image
  • images.image_name.tag
  • images.image_name.snapshottable

engines

Includes the hash of engines that the current engine (the one that contains the dynamic property) has access to. This hash includes all engines from previous app steps as well as the current engine.

  • engines.engine_name.name

engines.engine_name.vars

  • engines.engine_name.vars.[].var_name

engines.engine_name.hooks

  • engines.engine_name.hooks.[].trigger_type
  • engines.engine_name.hooks.[].trigger_name
  • engines.engine_name.hooks.[].user
  • engines.engine_name.hooks.[].workdir
  • engines.engine_name.hooks.[].toggle
    • engines.engine_name.hooks.[].toggle.enabled.command
    • engines.engine_name.hooks.[].toggle.disabled.command

engines.engine_name.networking

  • engines.engine_name.networking.dns.enabled
  • engines.engine_name.networking.dns.label
  • engines.engine_name.networking.dns.default_value
  • engines.engine_name.networking.dns.value user-defined value.
  • engines.engine_name.networking.dns.url full URL in the following format: <dns_value>.<account_name>.myocean.io.
  • engines.engine_name.networking.ports
    • engines.engine_name.networking.ports.port_name.value
    • engines.engine_name.networking.ports.port_name.public

engines.engine_name.settings

Contains a hash of settings that can be accessed by their name.

  • engines.engine_name.settings.setting_name.label
  • engines.engine_name.settings.setting_name.default_value
  • engines.engine_name.settings.setting_name.value
  • engines.engine_name.settings.setting_name.style
  • engines.engine_name.settings.setting_name.description
  • engines.engine_name.settings.setting_name.group
  • engines.engine_name.settings.setting_name.options
    • engines.engine_name.settings.setting_name.options.[].label
    • engines.engine_name.settings.setting_name.options.[].value
  • engines.engine_name.settings.setting_name.validations
    • engines.engine_name.settings.setting_name.options.[].type
    • engines.engine_name.settings.setting_name.options.[].value

engines.engine_name.container

Contains information about engine’s container.

  • engines.engine_name.container
    • engines.engine_name.container.image
      • engines.engine_name.container.image.name
      • engines.engine_name.container.image.registry
      • engines.engine_name.container.image.image
      • engines.engine_name.container.image.tag
      • engines.engine_name.container.image.snapshottable
    • engines.engine_name.container.user
    • engines.engine_name.container.workdir
    • engines.engine_name.container.runner
      • engines.engine_name.container.runner.modes
    • engines.engine_name.container.mounts
      • engines.engine_name.container.mounts.app_installs
        • engines.engine_name.container.mounts.app_installs.app_install_name.app_files_path
        • engines.engine_name.container.mounts.app_installs.app_install_name.container_path
        • engines.engine_name.container.mounts.app_installs.app_install_name.readonly
        • engines.engine_name.container.mounts.app_installs.app_install_name.shared
      • engines.engine_name.container.mounts.data_stores
    • engines.engine_name.container.nodes
      • engines.engine_name.container.nodes.main
        • engines.engine_name.container.nodes.main.env_vars
          • engines.engine_name.container.nodes.main.env_vars.var_name
        • engines.engine_name.container.nodes.main.entrypoint
        • engines.engine_name.container.nodes.main.command
      • engines.engine_name.container.nodes.worker
        • engines.engine_name.container.nodes.worker.env_vars
          • engines.engine_name.container.nodes.worker.env_vars.var_name
        • engines.engine_name.container.nodes.worker.entrypoint
        • engines.engine_name.container.nodes.worker.command

engines.engine_name.deployment

Contains information about engine’s current host deployment.

  • engines.engine_name.deployment.strategy
  • engines.engine_name.deployment.key
    • engines.engine_name.deployment.keyname
    • engines.engine_name.deployment.key.algorithm
    • engines.engine_name.deployment.key.length
    • engines.engine_name.deployment.key.public_key
    • engines.engine_name.deployment.key.ssh_public_key
    • engines.engine_name.deployment.key.private_key
  • engines.engine_name.deployment.hardware
    • engines.engine_name.deployment.hardware.node_type
    • engines.engine_name.deployment.hardware.root_volume_size
    • engines.engine_name.deployment.hardware.cpu
      • engines.engine_name.deployment.hardware.cpu.vcpus
      • engines.engine_name.deployment.hardware.cpu.cores
      • engines.engine_name.deployment.hardware.cpu.threads_per_core
      • engines.engine_name.deployment.hardware.cpu.clock
      • engines.engine_name.deployment.hardware.cpu.sockets
    • engines.engine_name.deployment.hardware.memory
    • engines.engine_name.deployment.hardware.gpus
    • engines.engine_name.deployment.hardware.limits
      • engines.engine_name.deployment.hardware.limits.vcpus
      • engines.engine_name.deployment.hardware.limits.memory
      • engines.engine_name.deployment.hardware.limits.shared_memory
  • engines.engine_name.deployment.nodes
    • engines.engine_name.deployment.nodes.main
      • engines.engine_name.deployment.nodes.main.hostname
      • engines.engine_name.deployment.nodes.main.public_ip
      • engines.engine_name.deployment.nodes.main.private_ip
      • engines.engine_name.deployment.nodes.main.state_code
      • engines.engine_name.deployment.nodes.main.os_status_code
      • engines.engine_name.deployment.nodes.main.network_status_code
    • engines.engine_name.deployment.nodes.workers
      • engines.engine_name.deployment.nodes.workers.[].hostname
      • engines.engine_name.deployment.nodes.workers.[].public_ip
      • engines.engine_name.deployment.nodes.workers.[].private_ip
      • engines.engine_name.deployment.nodes.workers.[].state_code
      • engines.engine_name.deployment.nodes.workers.[].os_status_code
      • engines.engine_name.deployment.nodes.workers.[].network_status_code

engines.engine_name.ui

Describes engine UI. It’s only accessible in the UI properties of the engine.

  • engines.engine_name.ui.buttons.self
    • engines.engine_name.ui.buttons.self.label
    • engines.engine_name.ui.buttons.self.url
    • engines.engine_name.ui.badges.self.is_visible?
    • engines.engine_name.ui.buttons.self.node
      • engines.engine_name.ui.buttons.self.node.hostname
      • engines.engine_name.ui.buttons.self.node.public_ip
      • engines.engine_name.ui.buttons.self.node.private_ip
  • engines.engine_name.ui.badges.self defines properties relevant for the current badge. This object can only be accessed by the badge itself.
    • engines.engine_name.ui.badges.self.label
    • engines.engine_name.ui.badges.self.tooltip
    • engines.engine_name.ui.badges.self.is_visible?
    • engines.engine_name.ui.badges.self.node
      • engines.engine_name.ui.badges.self.node.hostname
      • engines.engine_name.ui.badges.self.node.public_ip
      • engines.engine_name.ui.badges.self.node.private_ip