[lxc-devel] [linuxcontainers.org/master] Changes to getting-started-cli.md and additions to css
toby63 on Github
lxc-bot at linuxcontainers.org
Fri Jun 5 15:05:51 UTC 2020
A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 981 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20200605/68f3de1c/attachment.bin>
-------------- next part --------------
From 07b8f977a5686e4e31feb2ffdd167cfd73174603 Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:33:18 +0200
Subject: [PATCH 1/7] added css for admonition
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
static/css/local.css | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/static/css/local.css b/static/css/local.css
index ede6b00..d2eff94 100644
--- a/static/css/local.css
+++ b/static/css/local.css
@@ -283,3 +283,31 @@ pre {
.p-notification__response {
max-width: none;
}
+
+/*admonition*/
+.admonition {
+ margin-bottom: 10px;
+ margin-left: 15px;
+ border: 1px solid transparent;
+ border-radius: 1px;
+ padding-bottom: 10px;
+ width: 50%;
+}
+
+.admonition.note {
+ color: #000000;
+ border-color: #000000;
+}
+
+.admonition-title {
+ color: #3a87ad;
+ font-weight: bold;
+ text-align: left;
+ background-color: rgb(37, 62, 78);
+ padding: 8px;
+ display: block;
+}
+
+.p-noteadm {
+ padding: 5px;
+}
From f7c77f0db85a48c9576a18dc384107ced7fa6b8a Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:35:23 +0200
Subject: [PATCH 2/7] added background-color for "code" in css
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
static/css/local.css | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/static/css/local.css b/static/css/local.css
index d2eff94..ea69928 100644
--- a/static/css/local.css
+++ b/static/css/local.css
@@ -311,3 +311,7 @@ pre {
.p-noteadm {
padding: 5px;
}
+
+code {
+ background-color: #a19d9d;
+}
From 1f915f08ec39873f27587536cf1e5db1a06f826c Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:41:27 +0200
Subject: [PATCH 3/7] getting-started-cli.md - minor changes to install linux
section
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
content/lxd/getting-started-cli.md | 32 +++++++++++++++++++-----------
1 file changed, 20 insertions(+), 12 deletions(-)
diff --git a/content/lxd/getting-started-cli.md b/content/lxd/getting-started-cli.md
index 51f461d..a71d3cc 100644
--- a/content/lxd/getting-started-cli.md
+++ b/content/lxd/getting-started-cli.md
@@ -2,6 +2,8 @@
[TOC]
+---
+
# Installation
## Choose your release
LXD upstream maintains three release branches in parallel:
@@ -15,30 +17,33 @@ and security updates but will not see new features added or any kind of behavior
To get all the latest features and monthly updates to LXD, use the feature release branch instead.
## Getting the packages
-### Alpine Linux
+
+### Linux
+
+#### Alpine Linux
To install the feature branch of LXD, run:
apk add lxd
-### Arch Linux
+#### Arch Linux
To install the feature branch of LXD, run:
pacman -S lxd
-Alternatively, the snap package can also be used on Arch Linux (see below).
+Alternatively, the snap package can also be used on Arch Linux ([see below](#snap-package-arch-linux-debian-fedora-opensuse-and-ubuntu)).
-### Fedora
+#### Fedora
Instructions on how to use the COPR repository for LXD can be [found here](https://copr.fedorainfracloud.org/coprs/ganto/lxc3/).
-Alternatively, the snap package can also be used on Fedora (see below).
+Alternatively, the snap package can also be used on Fedora ([see below](#snap-package-arch-linux-debian-fedora-opensuse-and-ubuntu)).
-### Gentoo
+#### Gentoo
To install the feature branch of LXD, run:
emerge --ask lxd
-### Ubuntu
-#### Ubuntu (all releases)
+#### Ubuntu
+##### Ubuntu (all releases)
The recommended way to install LXD these days is with the snap.
For the latest stable release, use:
@@ -61,12 +66,12 @@ If you previously had the LXD deb package installed, you can migrate all your ex
lxd.migrate
-#### Ubuntu 14.04 LTS (LXD 2.0 deb)
+##### Ubuntu 14.04 LTS (LXD 2.0 deb)
To install the LTS branch of LXD, run:
apt install -t trusty-backports lxd lxd-client
-#### Ubuntu 16.04 LTS (LXD 3.0 deb)
+##### Ubuntu 16.04 LTS (LXD 3.0 deb)
To install the LTS branch of LXD, run:
apt install lxd lxd-client
@@ -75,7 +80,7 @@ To install the feature branch of LXD, run:
apt install -t xenial-backports lxd lxd-client
-### Snap package (Arch Linux, Debian, Fedora, OpenSUSE and Ubuntu)
+#### Snap package (Arch Linux, Debian, Fedora, OpenSUSE and Ubuntu)
LXD upstream publishes and tests a snap package which works for a number of Linux distributions.
The list of Linux distributions we currently test our snap for can be [found here](https://jenkins.linuxcontainers.org/job/lxd-test-snap-latest-stable/).
@@ -86,7 +91,10 @@ After that, you can install LXD with:
snap install lxd
-Alternatively, pass `--channel=4.0/stable` for the LXD 4.0 LTS release, `--channel=3.0/stable` for the LXD 3.0 LTS release or `--channel=2.0/stable` for the LXD 2.0 LTS release.
+Alternatively, pass:
+`--channel=4.0/stable` for the LXD 4.0 LTS release,
+`--channel=3.0/stable` for the LXD 3.0 LTS release or
+`--channel=2.0/stable` for the LXD 2.0 LTS release.
### MacOS builds
LXD upstream publishes builds of the LXD client for macOS through [Homebrew](https://brew.sh/).
From 7445aa30ac880f5fd53092537fc478e48a0f3cda Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:45:39 +0200
Subject: [PATCH 4/7] getting-started-cli.md - added admonitions for windows
and macos (only client included)
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
content/lxd/getting-started-cli.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/content/lxd/getting-started-cli.md b/content/lxd/getting-started-cli.md
index a71d3cc..b576b03 100644
--- a/content/lxd/getting-started-cli.md
+++ b/content/lxd/getting-started-cli.md
@@ -97,6 +97,11 @@ Alternatively, pass:
`--channel=2.0/stable` for the LXD 2.0 LTS release.
### MacOS builds
+
+!!! note "Note:"
+ The builds for MacOS only include the client, not the server.
+ {: .p-noteadm }
+
LXD upstream publishes builds of the LXD client for macOS through [Homebrew](https://brew.sh/).
To install the feature branch of LXD, run:
@@ -104,6 +109,11 @@ To install the feature branch of LXD, run:
brew install lxc
### Windows builds
+
+!!! note "Note:"
+ The builds for Windows only include the client, not the server.
+ {: .p-noteadm }
+
Native builds of the LXD client for Windows can be [found here](https://ci.appveyor.com/project/lxc/lxd/branch/master/artifacts).
### Installing from source
From 1bc0a66e3571097f3dbb25eb8c76c6e5202e4ab3 Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:47:30 +0200
Subject: [PATCH 5/7] getting-started-cli.md - specified link to "building
from source" on lxd github repo
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
content/lxd/getting-started-cli.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/content/lxd/getting-started-cli.md b/content/lxd/getting-started-cli.md
index b576b03..34de56f 100644
--- a/content/lxd/getting-started-cli.md
+++ b/content/lxd/getting-started-cli.md
@@ -117,7 +117,7 @@ To install the feature branch of LXD, run:
Native builds of the LXD client for Windows can be [found here](https://ci.appveyor.com/project/lxc/lxd/branch/master/artifacts).
### Installing from source
-Instructions on building and installing LXD from source [can be found here](https://github.com/lxc/lxd/).
+Instructions on building and installing LXD from source [can be found here](https://github.com/lxc/lxd/#installing-lxd-from-source).
# Initial configuration
Before you can create containers, you need to tell LXD a little bit about your storage and network needs.
From 24646b81847758ca6c14632b0ca9bc3988412170 Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:53:13 +0200
Subject: [PATCH 6/7] getting-started-cli.md - Extended the "Initial
configuration"-section, added a table for configuration options etc.
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
content/lxd/getting-started-cli.md | 26 ++++++++++++++++++++++++--
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/content/lxd/getting-started-cli.md b/content/lxd/getting-started-cli.md
index 34de56f..57512cd 100644
--- a/content/lxd/getting-started-cli.md
+++ b/content/lxd/getting-started-cli.md
@@ -120,12 +120,34 @@ Native builds of the LXD client for Windows can be [found here](https://ci.appve
Instructions on building and installing LXD from source [can be found here](https://github.com/lxc/lxd/#installing-lxd-from-source).
# Initial configuration
-Before you can create containers, you need to tell LXD a little bit about your storage and network needs.
-This is all done with:
+!!! note "Note:"
+ `instances`
+ : means both `containers` and `virtual machines`.
+ {: .p-notebrf }
+
+Before you can create an instance, you need to configure LXD.
+
+Run the following as root:
lxd init
+
+**Overview of the configuration options:**
+
+`default=no`
+: means the feature is disabled by default
+
+| Feature: | Description: | Basic Configuration Options: | More Information: |
+| --- | ------------- | --- | --- |
+| Clustering | A Cluster combines several LXD-servers. They share the same distributed database and can be managed uniformly using the LXD-client (lxc) or the REST API. | default=`no`; <br> If set to `yes`, you can either connect to an existing cluster or create a new one. | LXD-documentation: <br> [[clustering]] |
+| MAAS server | "MAAS is an open-source tool that lets you build a data centre from bare-metal servers." | default=`no`; <br> If set to `yes`, you can connect to an existing MAAS-server and specify the `name`, `URL` and `API key`. | - [maas.io](https://maas.io/) <br> - [maas - install with lxd](https://maas.io/docs/install-with-lxd) |
+| Network bridge | Provides network access for the instances. | You can either use an existing bridge (or interface) or let LXD create a new bridge (recommended option). <br> You can also create additional bridges and assign them to instances later. | LXD-documentation: <br> - [[networks]] <br> - [Network interface](https://linuxcontainers.org/lxd/docs/master/instances#type-nic) |
+| Storage pools | Instances etc. are stored in storage pools. | For testing purposes you can create a loop-backed storage pool. <br> But for production use it is recommended to use a partition (or full disk) instead of loop-backed storages (Reasons include: loop-backed pools are slower and their size can't be reduced). <br> The recommended backends are `ZFS` and `btrfs`. <br> You can also create additional storage pools later. | LXD-documentation: <br> - [[storage]] <br> - [Backend Comparison Chart](https://linuxcontainers.org/lxd/docs/master/storage#feature-comparison) |
+| Network Access | Allows access to the server over network. | default=`no`; <br> If set to `yes`, you can connect to the server over network. <br> You can set a `password` or accept the client certificate manually. | - |
+| Automatic Image Update | You can download Images from Image servers, in this case images can be updated automatically. | default=`yes`; <br> If set to `yes`, LXD will update the downloaded images regularly. | LXD-documentation: <br> [[image-handling]] |
+| "YAML lxd init preseed" | Will display a summary of your chosen configuration options in the terminal. | default=`no` | - |
+
## Access control
Access control for LXD is based on group membership.
The root user as well as members of the "lxd" group can interact with the local daemon.
From fc4485ac7a3428781e61fa1ceadb3bf2e66f6f3f Mon Sep 17 00:00:00 2001
From: Tobias Gerold <tobias at g3ro.eu>
Date: Fri, 5 Jun 2020 16:56:18 +0200
Subject: [PATCH 7/7] getting-started-cli.md - "Access Control" - replaced the
warning with an admonition
Signed-off-by: Tobias Gerold <tobias at g3ro.eu>
---
content/lxd/getting-started-cli.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/content/lxd/getting-started-cli.md b/content/lxd/getting-started-cli.md
index 57512cd..e4e8857 100644
--- a/content/lxd/getting-started-cli.md
+++ b/content/lxd/getting-started-cli.md
@@ -158,10 +158,9 @@ You can then add trusted users to it. Anyone added to this group will have full
Because group membership is normally only applied at login, you may need to either re-open your user session
or use the "newgrp lxd" command in the shell you're going to use to talk to LXD.
-**WARNING**: Anyone with access to the LXD socket can fully control LXD,
-which includes the ability to attach host devices and filesystems, this
-should therefore only be given to users who would be trusted with root
-access to the host. You can learn more about LXD security [here](/lxd/docs/master/security).
+!!! note "Warning:"
+ Anyone with access to the LXD socket can fully control LXD, which includes the ability to attach host devices and filesystems, this should therefore only be given to users who would be trusted with root access to the host. You can learn more about LXD security [here](/lxd/docs/master/security).
+ {: .p-notebrf }
# Creating and using your first container
Creating your first container is as simple as:
More information about the lxc-devel
mailing list