Class: PodmanLogin

Login to a Container registry using Podman

classDiagram class PodmanLogin IacModule <|-- PodmanLogin PodmanLogin : authfile PodmanLogin ..> string : authfile PodmanLogin : certdir PodmanLogin ..> string : certdir PodmanLogin : executable PodmanLogin ..> string : executable PodmanLogin : password PodmanLogin ..> string : password PodmanLogin : registry PodmanLogin ..> string : registry PodmanLogin : tlsverify PodmanLogin ..> boolean : tlsverify PodmanLogin : username PodmanLogin ..> string : username

Inheritance

IacModule
- PodmanLogin

Slots

Name	Cardinality and Range	Description	Inheritance
authfile	0..1 xsd:string	A file used for authentication	direct
certdir	0..1 xsd:string	Certificate directory	direct
password	0..1 xsd:string	Used for user authentication to prove identity or access approval	direct
registry	0..1 xsd:string	Set of records with a single structure arranged according to a criterion, pro...	direct
tlsverify	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	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:PodmanLogin
native	containers:PodmanLogin

LinkML Source

Direct

name: PodmanLogin
description: Login to a Container registry using Podman
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slots:
- authfile
- certdir
- password
- registry
- tlsverify
- username
slot_usage:
  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
  certdir:
    name: certdir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d.
    domain_of:
    - PodmanLogin
  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
  password:
    name: password
    description: Password for the registry server.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    required: true
  registry:
    name: registry
    description: Registry server. If the registry is not specified, the first registry
      under `[registries.search]` from `registries.conf` will be used.
    domain_of:
    - PodmanLogin
  tlsverify:
    name: tlsverify
    description: Require HTTPS and verify certificates when contacting registries.
      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:
    - PodmanLogin
    range: boolean
  username:
    name: username
    description: Username for the registry server.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    required: true

Induced

name: PodmanLogin
description: Login to a Container registry 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``
      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
  certdir:
    name: certdir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d.
    domain_of:
    - PodmanLogin
  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
  password:
    name: password
    description: Password for the registry server.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    required: true
  registry:
    name: registry
    description: Registry server. If the registry is not specified, the first registry
      under `[registries.search]` from `registries.conf` will be used.
    domain_of:
    - PodmanLogin
  tlsverify:
    name: tlsverify
    description: Require HTTPS and verify certificates when contacting registries.
      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:
    - PodmanLogin
    range: boolean
  username:
    name: username
    description: Username for the registry server.
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    required: true
attributes:
  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: PodmanLogin
    domain_of:
    - PodmanContainer
    - PodmanLogin
    - PodmanLogout
    - PodmanPlay
    range: string
  certdir:
    name: certdir
    description: Use certificates at path (*.crt, *.cert, *.key) to connect to the
      registry. Default certificates directory is /etc/containers/certs.d.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: certdir
    owner: PodmanLogin
    domain_of:
    - PodmanLogin
    range: string
  password:
    name: password
    description: Password for the registry server.
    from_schema: https://w3id.org/lmodel/ucs-core
    slot_uri: uco-observable:password
    alias: password
    owner: PodmanLogin
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    range: string
    required: true
  registry:
    name: registry
    description: Registry server. If the registry is not specified, the first registry
      under `[registries.search]` from `registries.conf` will be used.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: registry
    owner: PodmanLogin
    domain_of:
    - PodmanLogin
    range: string
  tlsverify:
    name: tlsverify
    description: Require HTTPS and verify certificates when contacting registries.
      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: tlsverify
    owner: PodmanLogin
    domain_of:
    - PodmanLogin
    range: boolean
  username:
    name: username
    description: Username for the registry server.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: username
    owner: PodmanLogin
    domain_of:
    - PodmanImage
    - PodmanLogin
    - PodmanPlay
    range: string
    required: true
  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: PodmanLogin
    domain_of:
    - IacModule
    range: string