The following pull request was submitted through Github.
It can be accessed and reviewed at: https://github.com/lxc/lxd/pull/7899
This e-mail was sent by the LXC bot, direct replies will not reach the author
unless they happen to be subscribed to this list.
=== Description (from pull-request) ===
From f2f4cc35348c285248b561c735ddb044ea2d6fc3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgra...@ubuntu.com>
Date: Sun, 20 Sep 2020 15:08:38 -0400
Subject: [PATCH 1/2] doc/server: Fix escaping
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Stéphane Graber <stgra...@ubuntu.com>
---
doc/server.md | 82 +++++++++++++++++++++++++--------------------------
1 file changed, 41 insertions(+), 41 deletions(-)
diff --git a/doc/server.md b/doc/server.md
index d48ac21fb1..69ec82f559 100644
--- a/doc/server.md
+++ b/doc/server.md
@@ -12,47 +12,47 @@ currently supported:
- `maas` (MAAS integration)
- `rbac` (Role Based Access Control through external Candid + Canonical RBAC)
-Key | Type | Scope | Default
| API extension | Description
-:-- | :--- | :---- | :------
| :------------ | :----------
-backups.compression\_algorithm | string | global | gzip
| backup\_compression | Compression algorithm to
use for new images (bzip2, gzip, lzma, xz or none)
-candid.api.key | string | global | -
| candid\_config\_key | Public key of the candid
server (required for HTTP-only servers)
-candid.api.url | string | global | -
| candid\_authentication | URL of the the external
authentication endpoint using Candid
-candid.expiry | integer | global | 3600
| candid\_config | Candid macaroon expiry in
seconds
-candid.domains | string | global | -
| candid\_config | Comma-separated list of
allowed Candid domains (empty string means all domains are valid)
-cluster.https\_address | string | local | -
| clustering\_server\_address | Address the server should
using for clustering traffic
-cluster.offline\_threshold | integer | global | 20
| clustering | Number of seconds after
which an unresponsive node is considered offline
-cluster.images\_minimal\_replica | integer | global | 3
| clustering\_image\_replication | Minimal numbers of cluster
members with a copy of a particular image (set 1 for no replication, -1 for all
members)
-cluster.max\_voters | integer | global | 3
| clustering\_sizing | Maximum number of cluster
members that will be assigned the database voter role
-cluster.max\_standby | integer | global | 2
| clustering\_sizing | Maximum number of cluster
members that will be assigned the database stand-by role
-core.debug\_address | string | local | -
| pprof\_http | Address to bind the pprof
debug server to (HTTP)
-core.https\_address | string | local | -
| - | Address to bind for the
remote API (HTTPS)
-core.https\_allowed\_credentials | boolean | global | -
| - | Whether to set
Access-Control-Allow-Credentials http header value to "true"
-core.https\_allowed\_headers | string | global | -
| - |
Access-Control-Allow-Headers http header value
-core.https\_allowed\_methods | string | global | -
| - |
Access-Control-Allow-Methods http header value
-core.https\_allowed\_origin | string | global | -
| - |
Access-Control-Allow-Origin http header value
-core.proxy\_https | string | global | -
| - | https proxy to use, if any
(falls back to HTTPS\_PROXY environment variable)
-core.proxy\_http | string | global | -
| - | http proxy to use, if any
(falls back to HTTP\_PROXY environment variable)
-core.proxy\_ignore\_hosts | string | global | -
| - | hosts which don't need the
proxy for use (similar format to NO\_PROXY, e.g. 1.2.3.4,1.2.3.5, falls back to
NO\_PROXY environment variable)
-core.trust\_ca\_certificates | boolean | global | -
| - | Whether to automatically
trust clients signed by the CA
-core.trust\_password | string | global | -
| - | Password to be provided by
clients to setup a trust
-images.auto\_update\_cached | boolean | global | true
| - | Whether to automatically
update any image that LXD caches
-images.auto\_update\_interval | integer | global | 6
| - | Interval in hours at which
to look for update to cached images (0 disables it)
-images.compression\_algorithm | string | global | gzip
| - | Compression algorithm to
use for new images (bzip2, gzip, lzma, xz or none)
-images.remote\_cache\_expiry | integer | global | 10
| - | Number of days after which
an unused cached remote image will be flushed
-maas.api.key | string | global | -
| maas\_network | API key to manage MAAS
-maas.api.url | string | global | -
| maas\_network | URL of the MAAS server
-maas.machine | string | local | hostname
| maas\_network | Name of this LXD host in
MAAS
-rbac.agent.url | string | global | -
| rbac | The Candid agent url as
provided during RBAC registration
-rbac.agent.username | string | global | -
| rbac | The Candid agent username
as provided during RBAC registration
-rbac.agent.public\_key | string | global | -
| rbac | The Candid agent public
key as provided during RBAC registration
-rbac.agent.private\_key | string | global | -
| rbac | The Candid agent private
key as provided during RBAC registration
-rbac.api.expiry | integer | global | -
| rbac | RBAC macaroon expiry in
seconds
-rbac.api.key | string | global | -
| rbac | Public key of the RBAC
server (required for HTTP-only servers)
-rbac.api.url | string | global | -
| rbac | URL of the external RBAC
server
-storage.backups\_volume | string | local | -
| daemon\_storage | Volume to use to store the
backup tarballs (syntax is POOL/VOLUME)
-storage.images\_volume | string | local | -
| daemon\_storage | Volume to use to store the
image tarballs (syntax is POOL/VOLUME)
-network.ovn.integration\_bridge | string | global | br-int
| network\_type\_ovn | OVS integration bridge to
use for OVN networks
-network.ovn.northbound\_connection | string | global |
unix:/var/run/ovn/ovnnb_db.sock | network\_type\_ovn | OVN
northbound database connection string
+Key | Type | Scope | Default
| API extension | Description
+:-- | :--- | :---- | :------
| :------------ | :----------
+backups.compression\_algorithm | string | global | gzip
| backup\_compression | Compression algorithm to
use for new images (bzip2, gzip, lzma, xz or none)
+candid.api.key | string | global | -
| candid\_config\_key | Public key of the candid
server (required for HTTP-only servers)
+candid.api.url | string | global | -
| candid\_authentication | URL of the the external
authentication endpoint using Candid
+candid.expiry | integer | global | 3600
| candid\_config | Candid macaroon expiry
in seconds
+candid.domains | string | global | -
| candid\_config | Comma-separated list of
allowed Candid domains (empty string means all domains are valid)
+cluster.https\_address | string | local | -
| clustering\_server\_address | Address the server
should using for clustering traffic
+cluster.offline\_threshold | integer | global | 20
| clustering | Number of seconds after
which an unresponsive node is considered offline
+cluster.images\_minimal\_replica | integer | global | 3
| clustering\_image\_replication | Minimal numbers of
cluster members with a copy of a particular image (set 1 for no replication, -1
for all members)
+cluster.max\_voters | integer | global | 3
| clustering\_sizing | Maximum number of
cluster members that will be assigned the database voter role
+cluster.max\_standby | integer | global | 2
| clustering\_sizing | Maximum number of
cluster members that will be assigned the database stand-by role
+core.debug\_address | string | local | -
| pprof\_http | Address to bind the
pprof debug server to (HTTP)
+core.https\_address | string | local | -
| - | Address to bind for the
remote API (HTTPS)
+core.https\_allowed\_credentials | boolean | global | -
| - | Whether to set
Access-Control-Allow-Credentials http header value to "true"
+core.https\_allowed\_headers | string | global | -
| - |
Access-Control-Allow-Headers http header value
+core.https\_allowed\_methods | string | global | -
| - |
Access-Control-Allow-Methods http header value
+core.https\_allowed\_origin | string | global | -
| - |
Access-Control-Allow-Origin http header value
+core.proxy\_https | string | global | -
| - | https proxy to use, if
any (falls back to HTTPS\_PROXY environment variable)
+core.proxy\_http | string | global | -
| - | http proxy to use, if
any (falls back to HTTP\_PROXY environment variable)
+core.proxy\_ignore\_hosts | string | global | -
| - | hosts which don't need
the proxy for use (similar format to NO\_PROXY, e.g. 1.2.3.4,1.2.3.5, falls
back to NO\_PROXY environment variable)
+core.trust\_ca\_certificates | boolean | global | -
| - | Whether to automatically
trust clients signed by the CA
+core.trust\_password | string | global | -
| - | Password to be provided
by clients to setup a trust
+images.auto\_update\_cached | boolean | global | true
| - | Whether to automatically
update any image that LXD caches
+images.auto\_update\_interval | integer | global | 6
| - | Interval in hours at
which to look for update to cached images (0 disables it)
+images.compression\_algorithm | string | global | gzip
| - | Compression algorithm to
use for new images (bzip2, gzip, lzma, xz or none)
+images.remote\_cache\_expiry | integer | global | 10
| - | Number of days after
which an unused cached remote image will be flushed
+maas.api.key | string | global | -
| maas\_network | API key to manage MAAS
+maas.api.url | string | global | -
| maas\_network | URL of the MAAS server
+maas.machine | string | local | hostname
| maas\_network | Name of this LXD host in
MAAS
+rbac.agent.url | string | global | -
| rbac | The Candid agent url as
provided during RBAC registration
+rbac.agent.username | string | global | -
| rbac | The Candid agent
username as provided during RBAC registration
+rbac.agent.public\_key | string | global | -
| rbac | The Candid agent public
key as provided during RBAC registration
+rbac.agent.private\_key | string | global | -
| rbac | The Candid agent private
key as provided during RBAC registration
+rbac.api.expiry | integer | global | -
| rbac | RBAC macaroon expiry in
seconds
+rbac.api.key | string | global | -
| rbac | Public key of the RBAC
server (required for HTTP-only servers)
+rbac.api.url | string | global | -
| rbac | URL of the external RBAC
server
+storage.backups\_volume | string | local | -
| daemon\_storage | Volume to use to store
the backup tarballs (syntax is POOL/VOLUME)
+storage.images\_volume | string | local | -
| daemon\_storage | Volume to use to store
the image tarballs (syntax is POOL/VOLUME)
+network.ovn.integration\_bridge | string | global | br-int
| network\_type\_ovn | OVS integration bridge
to use for OVN networks
+network.ovn.northbound\_connection | string | global |
unix:/var/run/ovn/ovnnb\_db.sock | network\_type\_ovn | OVN
northbound database connection string
Those keys can be set using the lxc tool with:
From 4279a2c1e7e70f55b94da9cdff8604233402aca2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgra...@ubuntu.com>
Date: Sun, 20 Sep 2020 15:09:03 -0400
Subject: [PATCH 2/2] doc/server: Sort config keys
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Stéphane Graber <stgra...@ubuntu.com>
---
doc/server.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/doc/server.md b/doc/server.md
index 69ec82f559..05f04ee5b8 100644
--- a/doc/server.md
+++ b/doc/server.md
@@ -17,13 +17,13 @@ Key | Type | Scope
| Default
backups.compression\_algorithm | string | global | gzip
| backup\_compression | Compression algorithm to
use for new images (bzip2, gzip, lzma, xz or none)
candid.api.key | string | global | -
| candid\_config\_key | Public key of the candid
server (required for HTTP-only servers)
candid.api.url | string | global | -
| candid\_authentication | URL of the the external
authentication endpoint using Candid
-candid.expiry | integer | global | 3600
| candid\_config | Candid macaroon expiry
in seconds
candid.domains | string | global | -
| candid\_config | Comma-separated list of
allowed Candid domains (empty string means all domains are valid)
+candid.expiry | integer | global | 3600
| candid\_config | Candid macaroon expiry
in seconds
cluster.https\_address | string | local | -
| clustering\_server\_address | Address the server
should using for clustering traffic
-cluster.offline\_threshold | integer | global | 20
| clustering | Number of seconds after
which an unresponsive node is considered offline
cluster.images\_minimal\_replica | integer | global | 3
| clustering\_image\_replication | Minimal numbers of
cluster members with a copy of a particular image (set 1 for no replication, -1
for all members)
-cluster.max\_voters | integer | global | 3
| clustering\_sizing | Maximum number of
cluster members that will be assigned the database voter role
cluster.max\_standby | integer | global | 2
| clustering\_sizing | Maximum number of
cluster members that will be assigned the database stand-by role
+cluster.max\_voters | integer | global | 3
| clustering\_sizing | Maximum number of
cluster members that will be assigned the database voter role
+cluster.offline\_threshold | integer | global | 20
| clustering | Number of seconds after
which an unresponsive node is considered offline
core.debug\_address | string | local | -
| pprof\_http | Address to bind the
pprof debug server to (HTTP)
core.https\_address | string | local | -
| - | Address to bind for the
remote API (HTTPS)
core.https\_allowed\_credentials | boolean | global | -
| - | Whether to set
Access-Control-Allow-Credentials http header value to "true"
@@ -42,17 +42,17 @@ images.remote\_cache\_expiry | integer | global
| 10
maas.api.key | string | global | -
| maas\_network | API key to manage MAAS
maas.api.url | string | global | -
| maas\_network | URL of the MAAS server
maas.machine | string | local | hostname
| maas\_network | Name of this LXD host in
MAAS
+network.ovn.integration\_bridge | string | global | br-int
| network\_type\_ovn | OVS integration bridge
to use for OVN networks
+network.ovn.northbound\_connection | string | global |
unix:/var/run/ovn/ovnnb\_db.sock | network\_type\_ovn | OVN
northbound database connection string
+rbac.agent.private\_key | string | global | -
| rbac | The Candid agent private
key as provided during RBAC registration
+rbac.agent.public\_key | string | global | -
| rbac | The Candid agent public
key as provided during RBAC registration
rbac.agent.url | string | global | -
| rbac | The Candid agent url as
provided during RBAC registration
rbac.agent.username | string | global | -
| rbac | The Candid agent
username as provided during RBAC registration
-rbac.agent.public\_key | string | global | -
| rbac | The Candid agent public
key as provided during RBAC registration
-rbac.agent.private\_key | string | global | -
| rbac | The Candid agent private
key as provided during RBAC registration
rbac.api.expiry | integer | global | -
| rbac | RBAC macaroon expiry in
seconds
rbac.api.key | string | global | -
| rbac | Public key of the RBAC
server (required for HTTP-only servers)
rbac.api.url | string | global | -
| rbac | URL of the external RBAC
server
storage.backups\_volume | string | local | -
| daemon\_storage | Volume to use to store
the backup tarballs (syntax is POOL/VOLUME)
storage.images\_volume | string | local | -
| daemon\_storage | Volume to use to store
the image tarballs (syntax is POOL/VOLUME)
-network.ovn.integration\_bridge | string | global | br-int
| network\_type\_ovn | OVS integration bridge
to use for OVN networks
-network.ovn.northbound\_connection | string | global |
unix:/var/run/ovn/ovnnb\_db.sock | network\_type\_ovn | OVN
northbound database connection string
Those keys can be set using the lxc tool with:
_______________________________________________
lxc-devel mailing list
lxc-devel@lists.linuxcontainers.org
http://lists.linuxcontainers.org/listinfo/lxc-devel
