vyos_container¶
Title: vyos_container
VyOS Container configuration
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - registries | No | array of string | No | - | Unqualified search registries for any image that does not include the registry i ... |
| - networks | No | object | No | - | Container networks to be managed |
| - containers | No | object | No | - | Container to be managed |
vyos_container > registries¶
Unqualified search registries for any image that does not include the registry in the image name.
| Each item of this array must be | Description |
|---|---|
| items | - |
vyos_container > registries > items¶
vyos_container > networks¶
Container networks to be managed
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | In #/$defs/networkItem | - |
vyos_container > networks > networkItem¶
Examples:
network: services
description: test
network: services
description: test
prefix: 10.35.0.0/24
| All of(Requirement) |
|---|
| Base fields |
| Network entry fields |
vyos_container > networks > Network entry > allOf > Base fields¶
Title: Base fields
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - description | No | string | No | - | A string with a functional description of the network. |
vyos_container > networks > Network entry > allOf > Base fields > description¶
A string with a functional description of the network.
vyos_container > networks > Network entry > allOf > Network entry fields¶
Title: Network entry fields
| One of(Option) |
|---|
| Network entry with network reference |
| Network entry with custom prefix |
vyos_container > networks > Network entry > allOf > Network entry fields > oneOf > Network entry with network reference¶
Title: Network entry with network reference
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + network | No | string | No | - | A reference to the key of an entry in the VyOS networks list. The prefix will be ... |
vyos_container > networks > Network entry > allOf > Network entry fields > oneOf > Network entry with network reference > network¶
A reference to the key of an entry in the VyOS networks list. The prefix will be determined automatically.
vyos_container > networks > Network entry > allOf > Network entry fields > oneOf > Network entry with custom prefix¶
Title: Network entry with custom prefix
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + prefix | No | string | No | - | A network prefix to be assigned to this container network. |
vyos_container > networks > Network entry > allOf > Network entry fields > oneOf > Network entry with custom prefix > prefix¶
A network prefix to be assigned to this container network.
vyos_container > containers¶
Container to be managed
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | In #/$defs/containerItem | - |
vyos_container > containers > containerItem¶
| All of(Requirement) |
|---|
| Base fields |
| Networking fields |
vyos_container > containers > Container entry > allOf > Base fields¶
Title: Base fields
Example:
env:
TZ: UTC
image:
repository: vyos/vyos-build
tag: crux
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + image | No | object | No | - | Configures the container image. |
| - cap-add | No | array of string | No | - | A list of capabilities to be added to the container. |
| - env | No | object | No | - | A dict containing the environment variables to be set in the container. |
| - ports | No | object | No | - | A dict containing the ports to be configured in the container. |
| - volumes | No | object | No | - | A dict containing the volumes to be configured in the container. |
vyos_container > containers > Container entry > allOf > Base fields > image¶
Configures the container image.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + repository | No | string | No | - | The repository of the container image. |
| + tag | No | string | No | - | The tag of the container image. |
vyos_container > containers > Container entry > allOf > Base fields > image > repository¶
The repository of the container image.
vyos_container > containers > Container entry > allOf > Base fields > image > tag¶
The tag of the container image.
vyos_container > containers > Container entry > allOf > Base fields > cap-add¶
A list of capabilities to be added to the container.
Example:
cap-add:
- net-admin
| Each item of this array must be | Description |
|---|---|
| items | - |
vyos_container > containers > Container entry > allOf > Base fields > cap-add > items¶
vyos_container > containers > Container entry > allOf > Base fields > env¶
A dict containing the environment variables to be set in the container.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | string | No | - | - |
vyos_container > containers > Container entry > allOf > Base fields > env > additionalProperties¶
vyos_container > containers > Container entry > allOf > Base fields > ports¶
A dict containing the ports to be configured in the container.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | - |
vyos_container > containers > Container entry > allOf > Base fields > ports > additionalProperties¶
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + source | No | integer | No | - | The source port on the host. |
| + destination | No | integer | No | - | The destination port on the container. |
vyos_container > containers > Container entry > allOf > Base fields > ports > additionalProperties > source¶
The source port on the host.
vyos_container > containers > Container entry > allOf > Base fields > ports > additionalProperties > destination¶
The destination port on the container.
vyos_container > containers > Container entry > allOf > Base fields > volumes¶
A dict containing the volumes to be configured in the container.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | - |
vyos_container > containers > Container entry > allOf > Base fields > volumes > additionalProperties¶
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + source | No | integer | No | - | The source port on the host. |
| + destination | No | integer | No | - | The destination port on the container. |
vyos_container > containers > Container entry > allOf > Base fields > volumes > additionalProperties > source¶
The source port on the host.
vyos_container > containers > Container entry > allOf > Base fields > volumes > additionalProperties > destination¶
The destination port on the container.
vyos_container > containers > Container entry > allOf > Networking fields¶
Title: Networking fields
| One of(Option) |
|---|
| Host networking |
| Container networking |
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Host networking¶
Title: Host networking
Example:
allow-host-networks: true
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + allow-host-networks | No | boolean | No | - | Run the container with host networking enabled. |
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Host networking > allow-host-networks¶
Run the container with host networking enabled.
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Container networking¶
Title: Container networking
Use this if you want to configure this container with container networking.
Example:
networks:
services:
ipv4_hostid: 10
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + networks | No | object | No | - | Configures the container networks the container should run on. |
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Container networking > networks¶
Configures the container networks the container should run on.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | Container network entry |
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Container networking > networks > Container network entry¶
Title: Container network entry
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - ipv4_hostid | No | integer | No | - | The host id that is used to generate the IP address on the specified network |
vyos_container > containers > Container entry > allOf > Networking fields > oneOf > Container networking > networks > Container network entry > ipv4_hostid¶
The host id that is used to generate the IP address on the specified network
Generated using json-schema-for-humans on 2021-11-19 at 13:42:22 +0100