Skip to content

Class: PodmanLogout

Logout of a Container registry using Podman

URI: containers:PodmanLogout

classDiagram class PodmanLogout IacModule <|-- PodmanLogout PodmanLogout : all PodmanLogout ..> boolean : all PodmanLogout : authfile PodmanLogout ..> string : authfile PodmanLogout : executable PodmanLogout ..> string : executable PodmanLogout : ignore_docker_credentials PodmanLogout ..> boolean : ignore_docker_credentials

Inheritance

Slots

Name Cardinality and Range Description Inheritance
all 0..1
xsd:string		 The whole quantity or extent of a particular group or thing direct
authfile 0..1
xsd:string		 A file used for authentication direct
ignore_docker_credentials 0..1
xsd:string		 Credentials created using other tools such as docker login are not removed ... direct
executable 0..1
xsd:string		 Path to podman executable if it is not in the $PATH on the machine running po... IacModule

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: PodmanLogout
description: Logout of a Container registry using Podman
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slots:
- all
- authfile
- ignore_docker_credentials
slot_usage:
  all:
    name: all
    description: Remove the cached credentials for all registries in the auth file.
    domain_of:
    - PodmanLogout
    range: boolean
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json``
      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
  executable:
    name: executable
    description: Path to podman executable if it is not in the $PATH on the machine
      running podman
    ifabsent: string(podman)
    domain_of:
    - IacModule
  ignore_docker_credentials:
    name: ignore_docker_credentials
    description: Credentials created using other tools such as `docker login` are
      not removed unless the corresponding `authfile` is explicitly specified. Since
      podman also uses existing credentials in these files by default (for docker
      e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker
      login exists for the registry specified in any `authfile` is used by podman.
      This can be ignored by setting `ignore_docker_credentials` to `yes` - the credentials
      will be kept and `changed` will be false. This option cannot be used together
      with `all` since in this case podman will not check for existing `authfiles`
      created by other tools.
    domain_of:
    - PodmanLogout
    range: boolean
  registry:
    name: registry
    description: Registry server. If the registry is not specified, the first registry
      under `[registries.search]` from `registries.conf` will be used.

Induced

name: PodmanLogout
description: Logout of a Container registry using Podman
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slot_usage:
  all:
    name: all
    description: Remove the cached credentials for all registries in the auth file.
    domain_of:
    - PodmanLogout
    range: boolean
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json``
      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
  executable:
    name: executable
    description: Path to podman executable if it is not in the $PATH on the machine
      running podman
    ifabsent: string(podman)
    domain_of:
    - IacModule
  ignore_docker_credentials:
    name: ignore_docker_credentials
    description: Credentials created using other tools such as `docker login` are
      not removed unless the corresponding `authfile` is explicitly specified. Since
      podman also uses existing credentials in these files by default (for docker
      e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker
      login exists for the registry specified in any `authfile` is used by podman.
      This can be ignored by setting `ignore_docker_credentials` to `yes` - the credentials
      will be kept and `changed` will be false. This option cannot be used together
      with `all` since in this case podman will not check for existing `authfiles`
      created by other tools.
    domain_of:
    - PodmanLogout
    range: boolean
  registry:
    name: registry
    description: Registry server. If the registry is not specified, the first registry
      under `[registries.search]` from `registries.conf` will be used.
attributes:
  all:
    name: all
    description: Remove the cached credentials for all registries in the auth file.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: all
    owner: PodmanLogout
    domain_of:
    - PodmanLogout
    range: boolean
  authfile:
    name: authfile
    description: Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json``
      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: PodmanLogout
    domain_of:
    - PodmanContainer
    - PodmanLogin
    - PodmanLogout
    - PodmanPlay
    range: string
  ignore_docker_credentials:
    name: ignore_docker_credentials
    description: Credentials created using other tools such as `docker login` are
      not removed unless the corresponding `authfile` is explicitly specified. Since
      podman also uses existing credentials in these files by default (for docker
      e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker
      login exists for the registry specified in any `authfile` is used by podman.
      This can be ignored by setting `ignore_docker_credentials` to `yes` - the credentials
      will be kept and `changed` will be false. This option cannot be used together
      with `all` since in this case podman will not check for existing `authfiles`
      created by other tools.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: ignore_docker_credentials
    owner: PodmanLogout
    domain_of:
    - PodmanLogout
    range: boolean
  executable:
    name: executable
    description: Path to podman executable if it is not in the $PATH on the machine
      running podman
    from_schema: https://w3id.org/lmodel/ucs-core
    ifabsent: string(podman)
    alias: executable
    owner: PodmanLogout
    domain_of:
    - IacModule
    range: string