Contrail vRouter Agent

  • By Juniper Openstack Software
Channel Revision Published Runs on
latest/stable 41 14 May 2024
Ubuntu 20.04 Ubuntu 18.04
juju deploy juniper-os-software-contrail-agent
Show information

Platform:

Ubuntu
20.04 18.04

Learn about configurations >

  • container-cpuset | string

    Limit the specific CPUs or cores a container can use. Value can be specified as either a hexidecimal bitmask e.g. 0xF or as a numbered list separated by commas e.g. 0,1 (ranges are also supported using '-' e.g. 0-2). It must specify only real cores cause contrail-vrouter-dpdk service will fail if specified core number is not present in the system.

  • container_runtime | string

    Default: docker

    Container runtime valid values are "docker" and "containerd". Warning! The changes will not be applied after the package is installed.

  • csn-mode | string

    The vrouter agent mode. The valid values are 'tor'/'tsn'/'tsn-no-forwarding' or empty.

  • docker-log-driver | string

    Default: json-file

    A logging driver for the service’s containers.

  • docker-log-options | string

    Default: max-size=20m max-file=5

    Logging options for the logging driver. Logging options available depend on which logging driver you use.

  • docker-opts | string

    Extra options to pass to the Docker config file '/etc/docker/daemon.json' in json format. e.g. {"iptables": false, "insecure-registries": ["host2", "tungstenfabric", "host1"]}

  • docker-password | string

    Password to the docker registry.

  • docker-registry | string

    Default: opencontrailnightly

    URL of docker-registry

  • docker-registry-insecure | boolean

    Is it docker-registry insecure and should docker be configured for it

  • docker-user | string

    Login to the docker registry.

  • docker_runtime | string

    Default: upstream

    Docker runtime to install valid values are "upstream" (Docker PPA), "apt" (Ubuntu archive), "auto" (Ubuntu archive), or "custom" (must have set `docker_runtime_repo` URL, `docker_runtime_key_url` URL and `docker_runtime_package` name). Warning! The changes will not be applied after the package is installed.

  • docker_runtime_key_url | string

    Custom Docker repository validation key URL. Warning! The changes will not be applied after the package is installed.

  • docker_runtime_package | string

    Custom Docker repository package name. Warning! The changes will not be applied after the package is installed.

  • docker_runtime_repo | string

    Custom Docker repository, given in deb format. Use `{ARCH}` to determine architecture at runtime. Use `{CODE}` to set release codename. E.g. `deb [arch={ARCH}] https://download.docker.com/linux/ubuntu {CODE} stable`. Warning! The changes will not be applied after the package is installed.

  • dpdk | boolean

    Use user space DPDK vRouter

  • dpdk-coremask | string

    Default: 1

    vRouter CPU affinity mask for dpdk forwarding threads. Value can be specified as either a hexidecimal bitmask e.g. 0xF or as a numbered list separated by commas e.g. 0,1 (ranges are also supported using '-' e.g. 0-2). It must specify only real cores cause contrail-vrouter-dpdk service will fail if specified core number is not present in the system.

  • dpdk-ctrl-thread-coremask | string

    Default: 1

    vRouter DPDK CPU affinity mask for dpdk ctrl threads. Value can be specified as either a hexidecimal bitmask e.g. 0xF or as a numbered list separated by commas e.g. 0,1 (ranges are also supported using '-' e.g. 0-2). It must specify only real cores cause contrail-vrouter-dpdk service will fail if specified core number is not present in the system. Supported from Contrail release 2003 and R1912.L2.

  • dpdk-driver | string

    Default: uio_pci_generic

    DPDK driver to use for physical interface. Interface can be specified using vhost-interface.

  • dpdk-hugepages | string

    Default: 70%

    Number of huge pages to reserve for use with DPDK vRouter and OpenStack instances. Value can be specified as percentage of system memory e.g. 70% or as number of huge pages e.g. 1434.

  • dpdk-main-mempool-size | string

    Main packet pool size.

  • dpdk-no-gro | boolean

    vRouter DPDK option to disable GRO on vRouter. Allowed values 0 / 1. If not set the default behaviour is enabled (false).

  • dpdk-no-gso | boolean

    vRouter DPDK option to disable GSO on vRouter. Allowed values 0 / 1. If not set the default behaviour is enabled (false).

  • dpdk-no-mrgbuf | boolean

    vRouter DPDK option to disable mergeable buffers on vRouter. Allowed values 0 / 1. If not set the default behaviour is enabled (false).

  • dpdk-pmd-rxd-size | string

    DPDK PMD Rx Descriptor size.

  • dpdk-pmd-txd-size | string

    DPDK PMD Tx Descriptor size.

  • dpdk-rx-ring-sz | string

    vRouter DPDK option to configure for forwarding lcores rx ring buffer size. If not there is default in dpdk bin is used which is 1024. Supported from Contrail release 2003 and R1912.L2.

  • dpdk-service-coremask | string

    Default: 1

    vRouter DPDK CPU affinity mask for dpdk service threads. Value can be specified as either a hexidecimal bitmask e.g. 0xF or as a numbered list separated by commas e.g. 0,1 (ranges are also supported using '-' e.g. 0-2). It must specify only real cores cause contrail-vrouter-dpdk service will fail if specified core number is not present in the system. Supported from Contrail release 2003 and R1912.L2.

  • dpdk-tx-ring-sz | string

    vRouter DPDK option to configure for forwarding lcores tx ring buffer size. If not there is default in dpdk bin is used which is 1024. Supported from Contrail release 2003 and R1912.L2.

  • dpdk-yield-option | string

    vRouter DPDK option to disable/enable yield on forwarding lcores. Allowed values 0 / 1. If not set the default behaviour is enalbed (1). Supported from Contrail release 2003 and R1912.L2.

  • hostname-use-fqdn | boolean

    Default: True

    Use fqdn for vrouter_hostname or use gethostname instead. fqdn is used in R5.1 and in further releases. R5.0 releases used hostname that doesn’t always return the fully qualified domain name.

  • http_proxy | string

    URL to use for HTTP_PROXY to be used by Docker. Only useful in closed environments where a proxy is the only option for routing to the registry to pull images

  • https_proxy | string

    URL to use for HTTPS_PROXY to be used by Docker. Only useful in closed environments where a proxy is the only option for routing to the registry to pull images

  • image-tag | string

    Default: latest

    Tag of docker image.

  • kernel-hugepages-1g | string

    Number of 1 GB huge pages to reserve for use with vRouter in kernel mode and OpenStack instances. Value can be specified as number of huge pages e.g. 10. To turn off HP suppor completely kernel-hugepages-1g and kernel-hugepages-2m must be set as '0' both. Supported from Contrail release 2005.

  • kernel-hugepages-2m | string

    Default: 1024

    Number of 2 MB huge pages to reserve for use with vRouter in kernel mode and OpenStack instances. Value can be specified as number of huge pages e.g. '1024'. To turn off HP suppor completely kernel-hugepages-1g and kernel-hugepages-2m must be set as '0' both. Supported from Contrail release 2005.

  • l3mh-cidr | string

    CIDR for L3MH feature. Bypassed to vrouter-agent container to initialise vhost0 in multi-homing mode. Please refer to vrouter documentation for more details. Can not be changed after first start of vrouter.

  • log-level | string

    Default: SYS_NOTICE

    Log level for contrail services. Valid values are: SYS_EMERG, SYS_ALERT, SYS_CRIT, SYS_ERR, SYS_WARN, SYS_NOTICE, SYS_INFO, SYS_DEBUG

  • max-vm-flows | string

    Maximum flows allowed per VM (given as % of maximum system flows)

  • nagios_context | string

    Default: juju

    Used by the nrpe subordinate charms. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.

  • nagios_servicegroups | string

    A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup

  • no_proxy | string

    Comma-separated list of destinations (either domain names or IP addresses) that should be directly accessed, by opposition of going through the proxy defined above. Must be less than 2023 characters long

  • physical-interface | string

    Specify the interface to install vhost0 on. If left empty, vhost0 will be installed on the default gateway interface.

  • sriov-numvfs | string

    A comma-separated list of NumVFS's for specified devices. The number of elements in the list should be equal to number of elements in sriov-physical-interface. List is supported only by R2008 and 1912.L2 releases and further. Passed list for previous release will not be applied - just one element is applicable. This parameter and sriov-physical-interface will be passed into agent container that will configure SR-IOV.

  • sriov-physical-interface | string

    A comma-separated list of interface names for SR-IOV. The number of elements in the list should be equal to number of elements in sriov-numvfs. List is supported only by R2008 and 1912.L2 releases and further. Passed list for previous release will not be applied - just one element is applicable. This parameter and sriov-numvfs will be passed into agent container that will configure SR-IOV.

  • tcmalloc-heap-limit-mb | string

    Limit total size of the process heap to the specified number of MiB. When we approach the limit the memory is released to the system more aggressively (more minor page faults). Zero means to allocate as long as system allows.

  • vhost-gateway | string

    Default: auto

    Specify the gateway for vhost0, either an IPv4 address or keyword 'auto'. 'auto' will set gateway automatically.

  • vrouter-module-options | string

    Vrouter kernel module options. This string is passed to agent container as env variable VROUTER_MODULE_OPTIONS. Format is "<parameter>=<value> <parameter>=<value>" E.g. "vr_flow_hold_limit=8196 vr_mpls_labels=196000 vr_nexthops=521000 vr_vrfs=65536"

  • wait-for-external-plugin | boolean

    Enable external vRouter datapath plugin. This can be used with the agilio-vrouter charm to enable a hardware offloaded vRouter datapath.

  • xflow-node-ip | string

    VIP of xflow servicegroups.