summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-07-25 08:54:34 +0000
committerDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-07-26 03:46:53 +0000
commit7e226f60b7a2bd7e854d14b2bfd9729e20b02119 (patch)
tree31a583f3c5c8438fa51e74310aa911859379e557 /share/man
parentUpdating container-image example build script for current debian releases. (diff)
downloadcompute-tools-7e226f60b7a2bd7e854d14b2bfd9729e20b02119.tar.xz
compute-tools-7e226f60b7a2bd7e854d14b2bfd9729e20b02119.zip
Renaming container create command to container build.
Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>
Diffstat (limited to 'share/man')
-rw-r--r--share/man/compute-tools.7.rst4
-rw-r--r--share/man/container-build-debconf.1.rst (renamed from share/man/container-create-debconf.1.rst)44
-rw-r--r--share/man/container-build-debootstrap.1.rst (renamed from share/man/container-create-debootstrap.1.rst)34
-rw-r--r--share/man/container-build.1.rst (renamed from share/man/container-create.1.rst)54
-rw-r--r--share/man/container.1.rst4
5 files changed, 70 insertions, 70 deletions
diff --git a/share/man/compute-tools.7.rst b/share/man/compute-tools.7.rst
index b6405b2..3252f05 100644
--- a/share/man/compute-tools.7.rst
+++ b/share/man/compute-tools.7.rst
@@ -96,8 +96,8 @@ Linux' overlay filesystem
Usage
=====
-Create a new container:
- sudo container create -n NAME
+Build a new container:
+ sudo container build -n NAME
Start a container:
sudo container start -n NAME
diff --git a/share/man/container-create-debconf.1.rst b/share/man/container-build-debconf.1.rst
index 69cab10..1649071 100644
--- a/share/man/container-create-debconf.1.rst
+++ b/share/man/container-build-debconf.1.rst
@@ -17,13 +17,13 @@
.. You should have received a copy of the GNU General Public License
.. along with this program. If not, see <https://www.gnu.org/licenses/>.
-========================
-container-create-debconf
-========================
+=======================
+container-build-debconf
+=======================
-------------------------------------------------------
-Create an advanced Debian based container with debconf
-------------------------------------------------------
+-----------------------------------------------------
+Build an advanced Debian based container with debconf
+-----------------------------------------------------
:manual section: 1
:manual group: Open Infrastructure
@@ -31,31 +31,31 @@ Create an advanced Debian based container with debconf
Synopsis
========
-| **container create -s debconf** ['OPTIONS']
-| **cnt cr -s debconf** ['OPTIONS']
+| **container build -s debconf** ['OPTIONS']
+| **cnt b -s debconf** ['OPTIONS']
-| **container create -s debian** ['OPTIONS']
-| **cnt cr -s debian** ['OPTIONS']
+| **container build -s debian** ['OPTIONS']
+| **cnt b -s debian** ['OPTIONS']
-| **container create -s progress-linux** ['OPTIONS']
-| **cnt cr -s progress-linux** ['OPTIONS']
+| **container build -s progress-linux** ['OPTIONS']
+| **cnt b -s progress-linux** ['OPTIONS']
Description
===========
-The debconf container creation script uses debconf(1) to automatically create a
+The debconf container build script uses debconf(1) to automatically build a
Debian based container.
Scope
-----
-Note that this container creation script can do a few things more than just
+Note that this container build script can do a few things more than just
automatically debootstrap based on a preseed file. It also allows you to set a
root password, configure the network, install certain packages and execute
hooks.
But: this is *not* a replacement for a configuration management system (like
-ansible, puppet, etc.). The intenion of this script is to create the initial
+ansible, puppet, etc.). The intenion of this script is to build the initial
container to that extend that a configuration management system can take over.
As an analogy, think of debian-installer: d-i sets up your system to make it
@@ -76,7 +76,7 @@ system:
Modes
-----
-This container creation script can be used under two different names: debian and
+This container build script can be used under two different names: debian and
progress-linux.
Alternative, calling it under the debconf name is equal to the debian mode.
@@ -113,13 +113,13 @@ The following script options are available:
Examples
========
-Create a Debian based container:
+Build a Debian based container:
- sudo container create -s debian -n debian.example.net
+ sudo container build -s debian -n debian.example.net
-Create a Progress Linux container:
+Build a Progress Linux container:
- sudo container create -s progress-linux -n progress.example.net
+ sudo container build -s progress-linux -n progress.example.net
Files
=====
@@ -129,8 +129,8 @@ The following files are used:
/etc/compute-tools/config:
Container configuration files.
-/usr/share/compute-tools/scripts:
- Container creation scripts.
+/usr/share/compute-tools/build-scripts:
+ Container build scripts.
/usr/share/doc/compute-tools:
Container documentation.
diff --git a/share/man/container-create-debootstrap.1.rst b/share/man/container-build-debootstrap.1.rst
index 8165cea..853b4dc 100644
--- a/share/man/container-create-debootstrap.1.rst
+++ b/share/man/container-build-debootstrap.1.rst
@@ -17,13 +17,13 @@
.. You should have received a copy of the GNU General Public License
.. along with this program. If not, see <https://www.gnu.org/licenses/>.
-============================
-container-create-debootstrap
-============================
+===========================
+container-build-debootstrap
+===========================
---------------------------------------------------------------------
-Create a basic Debian based container with debootstrap or mmdebstrap
---------------------------------------------------------------------
+-------------------------------------------------------------------
+Build a basic Debian based container with debootstrap or mmdebstrap
+-------------------------------------------------------------------
:manual section: 1
:manual group: Open Infrastructure
@@ -31,19 +31,19 @@ Create a basic Debian based container with debootstrap or mmdebstrap
Synopsis
========
-| **container create -s debootstrap** ['OPTIONS']
-| **cnt cr -s debootstrap** ['OPTIONS']
+| **container build -s debootstrap** ['OPTIONS']
+| **cnt b -s debootstrap** ['OPTIONS']
-| **container create -s mmdebstrap** ['OPTIONS']
-| **cnt cr -s mmdebstrap** ['OPTIONS']
+| **container build -s mmdebstrap** ['OPTIONS']
+| **cnt b -s mmdebstrap** ['OPTIONS']
Description
===========
-The debootstrap container creation script uses debootstrap(8) or mmdebstrap(1)
-to create a Debian based container.
+The debootstrap container build script uses debootstrap(8) or mmdebstrap(1)
+to build a Debian based container.
-This script creates a pure Debian system with three modificiations:
+This script builds a pure Debian system with three modificiations:
* apt cache of packages downloaded during debootstrap is cleaned
* hostname is set (container name) in /etc/hostname
@@ -72,15 +72,15 @@ The following script options are available:
Examples
========
-Create a Debian 11 (bullseye) based container with same architecture as the host
+Build a Debian 11 (bullseye) based container with same architecture as the host
system using debootstrap:
- sudo container create -s debootstrap -n bullseye.example.net
+ sudo container build -s debootstrap -n bullseye.example.net
-Create a Debian 11 (bullseye) based container with different architecture as the
+Build a Debian 11 (bullseye) based container with different architecture as the
host system using mmdebstrap:
- sudo container create -s mmdebstrap -n bullseye-i386.example.net -- -a i386
+ sudo container build -s mmdebstrap -n bullseye-i386.example.net -- -a i386
See also
========
diff --git a/share/man/container-create.1.rst b/share/man/container-build.1.rst
index cb10f97..55f2a9b 100644
--- a/share/man/container-create.1.rst
+++ b/share/man/container-build.1.rst
@@ -17,13 +17,13 @@
.. You should have received a copy of the GNU General Public License
.. along with this program. If not, see <https://www.gnu.org/licenses/>.
-================
-container-create
-================
+===============
+container-build
+===============
-------------------
-Create a container
-------------------
+-----------------
+Build a container
+-----------------
:manual section: 1
:manual group: Open Infrastructure
@@ -31,40 +31,40 @@ Create a container
Synopsis
========
-| **container create** ['OPTIONS']
-| **cnt cr** ['OPTIONS']
+| **container build** ['OPTIONS']
+| **cnt b** ['OPTIONS']
Description
===========
-The **container create** command creates a container based on a script.
+The **container build** command builds a container based on a script.
Scripts
-------
-The following container scripts are available:
+The following build scripts are available:
curl:
- Basic script to create Debian based container, see container-create-curl(1).
+ Basic script to build Debian based container, see container-create-curl(1).
debootstrap:
- Basic script to create Debian based container, see
- container-create-debootstrap(1).
+ Basic script to build Debian based container, see
+ container-build-debootstrap(1).
debconf:
- Advanced script to automatically create Debian based container, see
- container-create-debconf(1).
+ Advanced script to automatically build Debian based container, see
+ container-build-debconf(1).
default:
- Symlink (if existing) to a container script which is used if no script was
+ Symlink (if existing) to a build script which is used if no script was
specified. On Debian based system this can be managed through
update-alternatives(1), i.e. 'sudo update-alternatives --config
- container_script'.
+ container_build-script'.
Options
=======
-The following **container create** options are available:
+The following **container build** options are available:
-n, --name='NAME':
Specify container name.
@@ -76,7 +76,7 @@ The following **container create** options are available:
Specify capabilities to drop, see capabilities(7).
-s, --script='SCRIPT':
- Specify container creation script, defaults to 'debootstrap'.
+ Specify container build script, defaults to 'debootstrap'.
-v, --verbose:
Explain what is being done.
@@ -101,21 +101,21 @@ The following **container create** options are available:
Examples
========
-Create example.net container using curl script:
+Build example.net container using curl script:
- sudo container create -n example.net -s curl
+ sudo container build -n example.net -s curl
-Create example.net container using debootstrap script:
+Build example.net container using debootstrap script:
- sudo container create -n example.net -s debootstrap
+ sudo container build -n example.net -s debootstrap
-Create example.net container using debconf script:
+Build example.net container using debconf script:
- sudo container create -n example.net -s debconf
+ sudo container build -n example.net -s debconf
-Create example.net container with the default create script and start it:
+Build example.net container with the default build script and start it:
- sudo container create,start -n example.net
+ sudo container build,start -n example.net
See also
========
diff --git a/share/man/container.1.rst b/share/man/container.1.rst
index 61661ab..cce283b 100644
--- a/share/man/container.1.rst
+++ b/share/man/container.1.rst
@@ -53,8 +53,8 @@ Commands
The following **container** commands are available:
-create:
- Create a new container, see container-create(1).
+build:
+ Build a new container, see container-build(1).
start:
Start a container, see container-start(1).