LXD moved from linuxcontainers.org to Canonical

LXD project is now hosted under canonical docs and github projects instead of lxc. Supplemental tooling and messaging fixes included. Complete set of changes: * github: update doc link to workaround to have LXD and docker coexist * schema: Update link to upstream doc for LXD preseed * datasource/lxd: update link to upstream doc * doc/rtd: update for LXD moving to Canonical * tools/ds-identify: update link to upstream LXD doc * cloudinit/config: update link to LXD issue * github: fix link to contributing doc for CLA * tools: set LC_ALL to C.UTF-8 when sorting CLA signers list * github: alpha sort CLA signers list Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
georgehyde-dot · Jul 18, 2023 · 7d82c48 · 7d82c48
1 parent ebd7b2b
commit 7d82c48
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 18 deletions.
diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml
@@ -19,7 +19,7 @@ jobs:
           to have signed the Contributor License Agreement (CLA).
           Please sign the CLA by following our
           contribution guide at:
-            https://cloudinit.readthedocs.io/en/latest/topics/contributing.html
+            https://cloudinit.readthedocs.io/en/latest/development/contributing.html
 
           Thanks,
           Your friendly cloud-init upstream

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -78,7 +78,7 @@ jobs:
           sudo adduser $USER lxd
           # Jammy GH Action runners have docker installed, which edits iptables
           # in a way that is incompatible with lxd.
-          # https://linuxcontainers.org/lxd/docs/master/howto/network_bridge_firewalld/#prevent-issues-with-lxd-and-docker
+          # https://documentation.ubuntu.com/lxd/en/latest/howto/network_bridge_firewalld/#prevent-connectivity-issues-with-lxd-and-docker
           sudo iptables -I DOCKER-USER -j ACCEPT
           sudo lxd init --auto
       - name: Run integration Tests

diff --git a/cloudinit/config/cc_lxd.py b/cloudinit/config/cc_lxd.py
@@ -469,7 +469,7 @@ def maybe_cleanup_default(
     By removing any that lxd-init created, we simply leave the add/attach
     code intact.
 
-    https://github.com/lxc/lxd/issues/4649"""
+    https://github.com/canonical/lxd/issues/4649"""
     if net_name != _DEFAULT_NETWORK_NAME or not did_init:
         return
 

diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json
@@ -1682,7 +1682,7 @@
             },
             "preseed": {
               "type": "string",
-              "description": "Opaque LXD preseed YAML config passed via stdin to the command: lxd init --preseed. See: https://linuxcontainers.org/lxd/docs/master/preseed/ or lxd init --dump for viable config. Can not be combined with either ``lxd.init`` or ``lxd.bridge``."
+              "description": "Opaque LXD preseed YAML config passed via stdin to the command: lxd init --preseed. See: https://documentation.ubuntu.com/lxd/en/latest/howto/initialize/#non-interactive-configuration or lxd init --dump for viable config. Can not be combined with either ``lxd.init`` or ``lxd.bridge``."
             }
           }
         }

diff --git a/cloudinit/sources/DataSourceLXD.py b/cloudinit/sources/DataSourceLXD.py
@@ -5,7 +5,7 @@
  * Older LXD images may not have updates for cloud-init so NoCloud may
    still be detected on those images.
  * Detect LXD datasource when /dev/lxd/sock is an active socket file.
- * Info on dev-lxd API: https://linuxcontainers.org/lxd/docs/master/dev-lxd
+ * Info on dev-lxd API: https://documentation.ubuntu.com/lxd/en/latest/dev-lxd/
 """
 
 import os

diff --git a/doc/rtd/howto/predeploy_testing.rst b/doc/rtd/howto/predeploy_testing.rst
@@ -134,8 +134,8 @@ check out the :ref:`datasource_nocloud` page.
 
 
 .. _Multipass: https://multipass.run/
-.. _LXD: https://linuxcontainers.org/
+.. _LXD: https://ubuntu.com/lxd
 .. _QEMU: https://www.qemu.org/
-.. _Instance Configuration: https://linuxcontainers.org/lxd/docs/master/instances
-.. _Custom Network Configuration: https://linuxcontainers.org/lxd/docs/master/cloud-init
+.. _Instance Configuration: https://documentation.ubuntu.com/lxd/en/latest/instances/
+.. _Custom Network Configuration: https://documentation.ubuntu.com/lxd/en/latest/cloud-init/
 .. _cloud-utils: https://github.com/canonical/cloud-utils/
diff --git a/doc/rtd/reference/datasources/lxd.rst b/doc/rtd/reference/datasources/lxd.rst
@@ -111,4 +111,4 @@ DHCP configuration of ``eth1``:
     $ lxc config device add my-lxd eth1 nic name=eth1 nictype=bridged parent=my-bridge
     Device eth1 added to my-lxd
 
-.. _LXD socket device: https://linuxcontainers.org/lxd/docs/master/dev-lxd
+.. _LXD socket device: https://documentation.ubuntu.com/lxd/en/latest/dev-lxd/
diff --git a/doc/rtd/reference/network-config.rst b/doc/rtd/reference/network-config.rst
@@ -316,7 +316,7 @@ Example output:
    USERCTL=no
 
 
-.. _LXD: https://linuxcontainers.org/lxd/docs/master/cloud-init/#custom-network-configuration
+.. _LXD: https://documentation.ubuntu.com/lxd/en/latest/cloud-init/#how-to-specify-network-configuration-data
 .. _NetworkManager: https://networkmanager.dev
 .. _Netplan: https://netplan.io/
 .. _DigitalOcean JSON metadata: https://developers.digitalocean.com/documentation/metadata/

diff --git a/doc/rtd/tutorial/lxd.rst b/doc/rtd/tutorial/lxd.rst
@@ -171,5 +171,5 @@ Each module contains examples of how to use it.
 You can also head over to the :ref:`examples page<yaml_examples>` for
 examples of more common use cases.
 
-.. _LXD: https://linuxcontainers.org/lxd/
-.. _other installation options: https://linuxcontainers.org/lxd/getting-started-cli/#other-installation-options
+.. _LXD: https://ubuntu.com/lxd
+.. _other installation options: https://documentation.ubuntu.com/lxd/en/latest/installing/#other-installation-options
diff --git a/tests/integration_tests/modules/test_lxd.py b/tests/integration_tests/modules/test_lxd.py
@@ -205,7 +205,7 @@ def validate_preseed_storage_pools(client, preseed_cfg):
 
 def validate_preseed_projects(client: IntegrationInstance, preseed_cfg):
     # Support for projects by lxd init --preseed was added in lxd 4.12
-    # https://discuss.linuxcontainers.org/t/lxd-4-12-has-been-released/10424#projects-now-supported-by-lxd-init-dump-and-preseed-9
+    # https://github.com/canonical/lxd/releases/tag/lxd-4.12
     if CURRENT_RELEASE.series in ("bionic", "focal"):
         return
     for src_project in preseed_cfg.get("projects", []):
@@ -219,12 +219,12 @@ def validate_preseed_projects(client: IntegrationInstance, preseed_cfg):
         )
         project.pop("used_by", None)
 
-        # `features.storage.buckets` was introduced in lxd 5.5 . More info:
-        # https://discuss.linuxcontainers.org/t/lxd-5-5-has-been-released/14899
+        # `features.storage.buckets` was introduced in lxd 5.5. More info:
+        # https://github.com/canonical/lxd/releases/tag/lxd-5.5
         if "features.storage.buckets" in project["config"]:
             assert "true" == project["config"].pop("features.storage.buckets")
         # `features.networks.zones` was introduced in lxd 5.9. More info:
-        # https://discuss.linuxcontainers.org/t/lxd-5-9-has-been-released/
+        # https://github.com/canonical/lxd/releases/tag/lxd-5.9
         if "features.networks.zones" in project["config"]:
             assert "true" == project["config"].pop("features.networks.zones")
         assert project == src_project

diff --git a/tools/.github-cla-signers b/tools/.github-cla-signers
@@ -127,6 +127,7 @@ scorpion44
 shaardie
 shell-skrimp
 shi2wei3
+simondeziel
 slingamn
 slyon
 smoser

diff --git a/tools/check-cla-signers b/tools/check-cla-signers
@@ -2,13 +2,14 @@
 
 set -eu
 set -o pipefail
+export LC_ALL="C.UTF-8"
 
 CLA_SIGNERS_FILE="tools/.github-cla-signers"
 
 sort -f "${CLA_SIGNERS_FILE}" -o "${CLA_SIGNERS_FILE}"
 
 if [[ -n "$(git status --porcelain -- ${CLA_SIGNERS_FILE})" ]]; then
-    echo "Please make sure that ${CLA_SIGNERS_FILE} is in alphabetical order."
+    echo "Please make sure that ${CLA_SIGNERS_FILE} is in alphabetical order. Make sure to set LC_ALL=\"${LC_ALL}\""
     git --no-pager diff "${CLA_SIGNERS_FILE}"
     exit 1
 fi
diff --git a/tools/ds-identify b/tools/ds-identify
@@ -814,7 +814,7 @@ dscheck_MAAS() {
 }
 
 # LXD datasource requires active /dev/lxd/sock
-# https://linuxcontainers.org/lxd/docs/master/dev-lxd
+# https://documentation.ubuntu.com/lxd/en/latest/dev-lxd/
 dscheck_LXD() {
     if is_socket_file /dev/lxd/sock; then
         return ${DS_FOUND}