Skip to content

Class: PodmanPlay

Play kubernetes YAML file using podman

URI: containers:PodmanPlay

classDiagram class PodmanPlay IacModule <|-- PodmanPlay PodmanPlay : authfile PodmanPlay ..> string : authfile PodmanPlay : cert_dir PodmanPlay ..> string : cert_dir PodmanPlay : configmap PodmanPlay ..> string : configmap PodmanPlay : debug PodmanPlay ..> boolean : debug PodmanPlay : executable PodmanPlay ..> string : executable PodmanPlay : kube_file PodmanPlay ..> string : kube_file PodmanPlay : log_driver PodmanPlay ..> string : log_driver PodmanPlay : log_level PodmanPlay ..> ContainerLogLevelEnum : log_level PodmanPlay : network PodmanPlay ..> string : network PodmanPlay : password PodmanPlay ..> string : password PodmanPlay : quiet PodmanPlay ..> boolean : quiet PodmanPlay : recreate PodmanPlay ..> boolean : recreate PodmanPlay : seccomp_profile_root PodmanPlay ..> string : seccomp_profile_root PodmanPlay : state PodmanPlay ..> ContainerStateEnum : state PodmanPlay : tls_verify PodmanPlay ..> boolean : tls_verify PodmanPlay : username PodmanPlay ..> string : username

Inheritance

Slots

Name Cardinality and Range Description Inheritance
authfile 0..1
xsd:string		 A file used for authentication direct
cert_dir 0..1
xsd:string		 Use certificates at path (* direct
configmap 0..1
xsd:string		 A ConfigMap is an API object that lets you store configuration for other obje... direct
debug 0..1
xsd:string		 Return additional information which can be helpful for investigations direct
kube_file 0..1
xsd:string		 Path to file with YAML configuration for a Pod direct
log_driver 0..1
xsd:string		 Driver used for logging direct
log_level 0..1
xsd:string		 Message logging level direct
network 0..1
xsd:string		 Network that allows computers to share resources and communicate with each ot... direct
password 0..1
xsd:string		 Used for user authentication to prove identity or access approval direct
quiet 0..1
xsd:string		 Make or become silent, calm, or still direct
recreate 0..1
xsd:boolean		 Create again direct
seccomp_profile_root 0..1
xsd:string		 Directory path for seccomp profiles direct
state 0..1
xsd:string		 The way something is with respect to its main attributes direct
tls_verify 0..1
xsd:string		 Require HTTPS and verify certificates direct
username 0..1
xsd:string		 Identifier for a person in a computer system direct
executable 0..1
xsd:string		 Name of executable to run, by default ‘podman’ ifabsent: string(podman) IacModule

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/lmodel/ucs-containers

Mappings

Mapping Type Mapped Value
self containers:PodmanPlay
native containers:PodmanPlay

LinkML Source

Direct

name: PodmanPlay
description: Play kubernetes YAML file using podman
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slots:
- authfile
- cert_dir
- configmap
- debug
- kube_file
- log_driver
- log_level
- network
- password
- quiet
- recreate
- seccomp_profile_root
- state
- tls_verify
- username
slot_usage:
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json,
      which is set using podman login. If the authorization state is not found there,
      $HOME/.docker/config.json is checked, which is set using docker login. Note
      - You can also override the default path of the authentication file by setting
      the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path
    domain_of:
    - PodmanContainer
    - PodmanLogin
    - PodmanLogout
    - PodmanPlay
  cert_dir:
    name: cert_dir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d. (This option
      is not available with the remote Podman client)
    domain_of:
    - PodmanPlay
  configmap:
    name: configmap
    description: Use Kubernetes configmap YAML at path to provide a source for environment
      variable values within the containers of the pod. Note - The configmap option
      can be used multiple times to pass multiple Kubernetes configmap YAMLs
    multivalued: true
    domain_of:
    - PodmanPlay
  debug:
    name: debug
    description: Enable debug for the module.
    domain_of:
    - PodmanContainer
    - PodmanContainers
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  executable:
    name: executable
    description: 'Name of executable to run, by default ‘podman’ ifabsent: string(podman)'
    domain_of:
    - IacModule
  kube_file:
    name: kube_file
    description: Path to file with YAML configuration for a Pod.
    domain_of:
    - PodmanPlay
    required: true
  log_driver:
    name: log_driver
    description: Set logging driver for all created containers.
    domain_of:
    - PodmanContainer
    - PodmanPlay
  log_level:
    name: log_level
    description: Set logging level for podman calls. Log messages above specified
      level (“debug”|”info”|”warn”|”error”|”fatal”|”panic”) (default “error”)
    domain_of:
    - PodmanContainer
    - PodmanPlay
    range: ContainerLogLevelEnum
  network:
    name: network
    description: List of the names of CNI networks the pod should join.
    multivalued: true
    domain_of:
    - PodmanContainer
    - PodmanPlay
    - PodmanPod
  password:
    name: password
    description: The username and password to use to authenticate with the registry
      if required.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
  quiet:
    name: quiet
    description: Hide image pulls logs from output.
    domain_of:
    - PodmanPlay
    range: boolean
  recreate:
    name: recreate
    description: If pod already exists, delete it and run the new one.
    domain_of:
    - PodmanContainer
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  seccomp_profile_root:
    name: seccomp_profile_root
    description: Directory path for seccomp profiles (default is “/var/lib/kubelet/seccomp”).
      This option is not available with the remote Podman client
    domain_of:
    - PodmanPlay
  state:
    name: state
    description: Start the pod after creating it, or to leave it created only.
    domain_of:
    - PodmanContainer
    - PodmanImage
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    range: ContainerStateEnum
    required: true
  tls_verify:
    name: tls_verify
    description: Require HTTPS and verify certificates when contacting registries
      (default is true). If explicitly set to true, then TLS verification will be
      used. If set to false, then TLS verification will not be used. If not specified,
      TLS verification will be used unless the target registry is listed as an insecure
      registry in registries.conf.
    domain_of:
    - PodmanPlay
    range: boolean
  username:
    name: username
    description: The username and password to use to authenticate with the registry
      if required.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay

Induced

name: PodmanPlay
description: Play kubernetes YAML file using podman
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slot_usage:
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json,
      which is set using podman login. If the authorization state is not found there,
      $HOME/.docker/config.json is checked, which is set using docker login. Note
      - You can also override the default path of the authentication file by setting
      the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path
    domain_of:
    - PodmanContainer
    - PodmanLogin
    - PodmanLogout
    - PodmanPlay
  cert_dir:
    name: cert_dir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d. (This option
      is not available with the remote Podman client)
    domain_of:
    - PodmanPlay
  configmap:
    name: configmap
    description: Use Kubernetes configmap YAML at path to provide a source for environment
      variable values within the containers of the pod. Note - The configmap option
      can be used multiple times to pass multiple Kubernetes configmap YAMLs
    multivalued: true
    domain_of:
    - PodmanPlay
  debug:
    name: debug
    description: Enable debug for the module.
    domain_of:
    - PodmanContainer
    - PodmanContainers
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  executable:
    name: executable
    description: 'Name of executable to run, by default ‘podman’ ifabsent: string(podman)'
    domain_of:
    - IacModule
  kube_file:
    name: kube_file
    description: Path to file with YAML configuration for a Pod.
    domain_of:
    - PodmanPlay
    required: true
  log_driver:
    name: log_driver
    description: Set logging driver for all created containers.
    domain_of:
    - PodmanContainer
    - PodmanPlay
  log_level:
    name: log_level
    description: Set logging level for podman calls. Log messages above specified
      level (“debug”|”info”|”warn”|”error”|”fatal”|”panic”) (default “error”)
    domain_of:
    - PodmanContainer
    - PodmanPlay
    range: ContainerLogLevelEnum
  network:
    name: network
    description: List of the names of CNI networks the pod should join.
    multivalued: true
    domain_of:
    - PodmanContainer
    - PodmanPlay
    - PodmanPod
  password:
    name: password
    description: The username and password to use to authenticate with the registry
      if required.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
  quiet:
    name: quiet
    description: Hide image pulls logs from output.
    domain_of:
    - PodmanPlay
    range: boolean
  recreate:
    name: recreate
    description: If pod already exists, delete it and run the new one.
    domain_of:
    - PodmanContainer
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  seccomp_profile_root:
    name: seccomp_profile_root
    description: Directory path for seccomp profiles (default is “/var/lib/kubelet/seccomp”).
      This option is not available with the remote Podman client
    domain_of:
    - PodmanPlay
  state:
    name: state
    description: Start the pod after creating it, or to leave it created only.
    domain_of:
    - PodmanContainer
    - PodmanImage
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    range: ContainerStateEnum
    required: true
  tls_verify:
    name: tls_verify
    description: Require HTTPS and verify certificates when contacting registries
      (default is true). If explicitly set to true, then TLS verification will be
      used. If set to false, then TLS verification will not be used. If not specified,
      TLS verification will be used unless the target registry is listed as an insecure
      registry in registries.conf.
    domain_of:
    - PodmanPlay
    range: boolean
  username:
    name: username
    description: The username and password to use to authenticate with the registry
      if required.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
attributes:
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json,
      which is set using podman login. If the authorization state is not found there,
      $HOME/.docker/config.json is checked, which is set using docker login. Note
      - You can also override the default path of the authentication file by setting
      the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: authfile
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanLogin
    - PodmanLogout
    - PodmanPlay
    range: string
  cert_dir:
    name: cert_dir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d. (This option
      is not available with the remote Podman client)
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: cert_dir
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: string
  configmap:
    name: configmap
    description: Use Kubernetes configmap YAML at path to provide a source for environment
      variable values within the containers of the pod. Note - The configmap option
      can be used multiple times to pass multiple Kubernetes configmap YAMLs
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    multivalued: true
    alias: configmap
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: string
  debug:
    name: debug
    description: Enable debug for the module.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: debug
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanContainers
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  kube_file:
    name: kube_file
    description: Path to file with YAML configuration for a Pod.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: kube_file
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: string
    required: true
  log_driver:
    name: log_driver
    description: Set logging driver for all created containers.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: log_driver
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanPlay
    range: string
  log_level:
    name: log_level
    description: Set logging level for podman calls. Log messages above specified
      level (“debug”|”info”|”warn”|”error”|”fatal”|”panic”) (default “error”)
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: log_level
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanPlay
    range: ContainerLogLevelEnum
  network:
    name: network
    description: List of the names of CNI networks the pod should join.
    from_schema: https://w3id.org/lmodel/ucs-core
    slot_uri: uco-observable:network
    multivalued: true
    alias: network
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanPlay
    - PodmanPod
    range: string
  password:
    name: password
    description: The username and password to use to authenticate with the registry
      if required.
    from_schema: https://w3id.org/lmodel/ucs-core
    slot_uri: uco-observable:password
    alias: password
    owner: PodmanPlay
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    range: string
  quiet:
    name: quiet
    description: Hide image pulls logs from output.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: quiet
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: boolean
  recreate:
    name: recreate
    description: If pod already exists, delete it and run the new one.
    from_schema: https://w3id.org/lmodel/ucs-core
    ifabsent: 'False'
    alias: recreate
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanVolume
    range: boolean
  seccomp_profile_root:
    name: seccomp_profile_root
    description: Directory path for seccomp profiles (default is “/var/lib/kubelet/seccomp”).
      This option is not available with the remote Podman client
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: seccomp_profile_root
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: string
  state:
    name: state
    description: Start the pod after creating it, or to leave it created only.
    from_schema: https://w3id.org/lmodel/ucs-core
    is_a: associationSlot
    domain: Association
    slot_uri: uco-observable:state
    alias: state
    owner: PodmanPlay
    domain_of:
    - PodmanContainer
    - PodmanImage
    - PodmanNetwork
    - PodmanPlay
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    range: ContainerStateEnum
    required: true
  tls_verify:
    name: tls_verify
    description: Require HTTPS and verify certificates when contacting registries
      (default is true). If explicitly set to true, then TLS verification will be
      used. If set to false, then TLS verification will not be used. If not specified,
      TLS verification will be used unless the target registry is listed as an insecure
      registry in registries.conf.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: tls_verify
    owner: PodmanPlay
    domain_of:
    - PodmanPlay
    range: boolean
  username:
    name: username
    description: The username and password to use to authenticate with the registry
      if required.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: username
    owner: PodmanPlay
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    range: string
  executable:
    name: executable
    description: 'Name of executable to run, by default ‘podman’ ifabsent: string(podman)'
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: executable
    owner: PodmanPlay
    domain_of:
    - IacModule
    range: string