From ae1dd10bb530d5ba46e53f04009c8172d4a7561f Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Wed, 6 Nov 2019 23:16:37 +0000 Subject: github: new basic project readme See rendered content at https://github.com/blackboxsw/cloud-init/tree/github/readme --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 00000000..07347d98 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Cloud-init official mirror synced from https://launchpad.net/cloud-init + +[![Build Status](https://travis-ci.org/cloud-init/cloud-init.svg?branch=master)](https://travis-ci.org/cloud-init/cloud-init) [![Read the Docs](https://readthedocs.org/projects/cloudinit/badge/?version=latest&style=flat)](https://cloudinit.readthedocs.org) + +Cloud-init is the *industry standard* multi-distribution method for +cross-platform cloud instance initialization. It is supported across all +major public cloud providers, provisioning systems for private cloud +infrastructure, and bare-metal installations. + +Cloud instances are initialized from a disk image and instance data: + +- Cloud metadata +- User data (optional) +- Vendor data (optional) + +Cloud-init will identify the cloud it is running on during boot, read any +provided metadata from the cloud and initialize the system accordingly. This +may involve setting up the network and storage devices to configuring SSH +access key and many other aspects of a system. Later on the cloud-init will +also parse and process any optional user or vendor data that was passed to the +instance. + +## Getting involved +All contributions welcome! [Join us easily following our hacking guide](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html) + +## Getting help + +Having trouble? We would like to help! + +- Ask a question in the [``#cloud-init`` IRC channel on Freenode](https://webchat.freenode.net/?channel=#cloud-init) +- Join and ask questions on the [cloud-init mailing list](https://launchpad.net/~cloud-init) +- Find a bug? [Report bugs on Launchpad](https://bugs.launchpad.net/cloud-init) + +## Recent cloud-init upstream releases +Upstream release version | Release date | +--- | --- | +19.4 | planned (2019-12-XX) | +[19.3](https://launchpad.net/cloud-init/+milestone/19.3) | 2019-11-05 | +[19.2](https://launchpad.net/cloud-init/+milestone/19.2) | 2019-07-17 | +[19.1](https://launchpad.net/cloud-init/+milestone/19.1) | 2019-05-10 | + + +## Cloud-init distribution and cloud support +Note: Each linux distribution and cloud tracks cloud-init upstream updates at +a different pace. If your distribution or cloud doesn't contain a recent +cloud-init, suggest or propose an upgrade with your distribution of choice. + +| Supported OSes | Supported Public Clouds | Supported Private Clouds | +| --- | --- | --- | +| Ubuntu
SLES/openSUSE
RHEL/CentOS
Fedora
Gentoo Linux
Debian
ArchLinux
FreeBSD












| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
Digital Ocean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)















| + + +## Daily Package Builds +We host daily [Ubuntu Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes) that build package for each Ubuntu series from tip of cloud-init. + +For CentOS 7/8 we publish to a couple of COPR build repos: + + * [**cloud-init-dev**: daily builds from cloud-init tip](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/) + -- cgit v1.2.3 From 77299d4f1857a2edd043b5473f07b208a32fd99a Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Thu, 7 Nov 2019 21:59:34 +0000 Subject: docs: touchups in rtd intro and README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - rtd/index.rst: update sentence to read:   cloud-init will also parse and process any optional user data - rtd/topics/datasources/rbxcloud.rst: fix rst link names to build docs - README.md:   - update travis badge url to project home: github/canonical/cloud-init   - update page title to:     Cloud-init official project upstream as of 11/2019 --- README.md | 7 ++++--- doc/rtd/index.rst | 2 +- doc/rtd/topics/datasources/rbxcloud.rst | 4 ++-- 3 files changed, 7 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 07347d98..9e47b286 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# Cloud-init official mirror synced from https://launchpad.net/cloud-init +# Cloud-init official project upstream as of 11/2019 +This repository is also mirrored to https://launchpad.net/cloud-init -[![Build Status](https://travis-ci.org/cloud-init/cloud-init.svg?branch=master)](https://travis-ci.org/cloud-init/cloud-init) [![Read the Docs](https://readthedocs.org/projects/cloudinit/badge/?version=latest&style=flat)](https://cloudinit.readthedocs.org) +[![Build Status](https://travis-ci.org/canonical/cloud-init.svg?branch=master)](https://travis-ci.org/canonical/cloud-init) [![Read the Docs](https://readthedocs.org/projects/cloudinit/badge/?version=latest&style=flat)](https://cloudinit.readthedocs.org) Cloud-init is the *industry standard* multi-distribution method for cross-platform cloud instance initialization. It is supported across all @@ -21,7 +22,7 @@ also parse and process any optional user or vendor data that was passed to the instance. ## Getting involved -All contributions welcome! [Join us easily following our hacking guide](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html) +All contributions welcome! [Submit code and docs by following our hacking guide](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html) ## Getting help diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index db1cdb49..826e8c48 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -18,7 +18,7 @@ Cloud-init will identify the cloud it is running on during boot, read any provided metadata from the cloud and initialize the system accordingly. This may involve setting up the network and storage devices to configuring SSH access key and many other aspects of a system. Later on the cloud-init will -also parse and any optional user or vendor data that was passed to the +also parse and process any optional user or vendor data that was passed to the instance. Getting help diff --git a/doc/rtd/topics/datasources/rbxcloud.rst b/doc/rtd/topics/datasources/rbxcloud.rst index 3d465bed..76e4fe4c 100644 --- a/doc/rtd/topics/datasources/rbxcloud.rst +++ b/doc/rtd/topics/datasources/rbxcloud.rst @@ -15,11 +15,11 @@ Metadata drive Drive metadata is a `FAT`_-formatted partition with the ```CLOUDMD``` label on the system disk. Its contents are refreshed each time the virtual machine is restarted, if the partition exists. For more information see -`HyperOne docs`_. +`HyperOne Virtual Machine docs`_. .. _HyperOne: http://www.hyperone.com/ .. _Rootbox: https://rootbox.com/ .. _HyperOne Virtual Machine docs: http://www.hyperone.com/ -.. _vfat: https://en.wikipedia.org/wiki/File_Allocation_Table +.. _FAT: https://en.wikipedia.org/wiki/File_Allocation_Table .. vi: textwidth=78 -- cgit v1.2.3 From f64faaedb277fec42006597d2c21b3f8b99d5b87 Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 4 Dec 2019 11:03:24 -0800 Subject: doc: Updates to wording of README.md --- README.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9e47b286..bb9cf0d0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# Cloud-init official project upstream as of 11/2019 -This repository is also mirrored to https://launchpad.net/cloud-init +# cloud-init [![Build Status](https://travis-ci.org/canonical/cloud-init.svg?branch=master)](https://travis-ci.org/canonical/cloud-init) [![Read the Docs](https://readthedocs.org/projects/cloudinit/badge/?version=latest&style=flat)](https://cloudinit.readthedocs.org) @@ -21,40 +20,36 @@ access key and many other aspects of a system. Later on the cloud-init will also parse and process any optional user or vendor data that was passed to the instance. -## Getting involved -All contributions welcome! [Submit code and docs by following our hacking guide](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html) - ## Getting help -Having trouble? We would like to help! +If you need support, start with the [user documentation](https://cloudinit.readthedocs.io/en/latest/). + +If you need additional help consider reaching out with one of the following options: - Ask a question in the [``#cloud-init`` IRC channel on Freenode](https://webchat.freenode.net/?channel=#cloud-init) - Join and ask questions on the [cloud-init mailing list](https://launchpad.net/~cloud-init) - Find a bug? [Report bugs on Launchpad](https://bugs.launchpad.net/cloud-init) -## Recent cloud-init upstream releases -Upstream release version | Release date | ---- | --- | -19.4 | planned (2019-12-XX) | -[19.3](https://launchpad.net/cloud-init/+milestone/19.3) | 2019-11-05 | -[19.2](https://launchpad.net/cloud-init/+milestone/19.2) | 2019-07-17 | -[19.1](https://launchpad.net/cloud-init/+milestone/19.1) | 2019-05-10 | +## Distribution and cloud support - -## Cloud-init distribution and cloud support -Note: Each linux distribution and cloud tracks cloud-init upstream updates at -a different pace. If your distribution or cloud doesn't contain a recent -cloud-init, suggest or propose an upgrade with your distribution of choice. +Below are a list of the many OSes and clouds that contain and ship with cloud-init. If your +distribution or cloud is not listed or does not have a recent version of cloud-init, please +get in contact with that distribution and send them our way! | Supported OSes | Supported Public Clouds | Supported Private Clouds | | --- | --- | --- | | Ubuntu
SLES/openSUSE
RHEL/CentOS
Fedora
Gentoo Linux
Debian
ArchLinux
FreeBSD












| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
Digital Ocean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)















| +## To start developing cloud-init + +Checkout the [hacking](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html) +document that outlines the steps necessary to develop, test, and submit code. -## Daily Package Builds -We host daily [Ubuntu Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes) that build package for each Ubuntu series from tip of cloud-init. +## Daily builds -For CentOS 7/8 we publish to a couple of COPR build repos: +Daily builds are useful if you want to try the latest upstream code for the latest +features or to verify bug fixes. - * [**cloud-init-dev**: daily builds from cloud-init tip](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/) +For Ubuntu, see the [Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes). +For CentOS, see the [COPR build repos](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/) -- cgit v1.2.3 From e5771fa81ca90f477f7a08a68053e1a6f813913d Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 4 Dec 2019 11:07:07 -0800 Subject: doc: update links on README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bb9cf0d0..939a5a8e 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,9 @@ If you need support, start with the [user documentation](https://cloudinit.readt If you need additional help consider reaching out with one of the following options: - Ask a question in the [``#cloud-init`` IRC channel on Freenode](https://webchat.freenode.net/?channel=#cloud-init) -- Join and ask questions on the [cloud-init mailing list](https://launchpad.net/~cloud-init) -- Find a bug? [Report bugs on Launchpad](https://bugs.launchpad.net/cloud-init) +- Search the cloud-init [mailing list archive](https://lists.launchpad.net/cloud-init/) +- Better yet, join the [cloud-init mailing list](https://launchpad.net/~cloud-init) and participate +- Find a bug? [Report bugs on Launchpad](https://bugs.launchpad.net/cloud-init/+filebug) ## Distribution and cloud support @@ -50,6 +51,6 @@ document that outlines the steps necessary to develop, test, and submit code. Daily builds are useful if you want to try the latest upstream code for the latest features or to verify bug fixes. -For Ubuntu, see the [Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes). +For Ubuntu, see the [Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+archive/ubuntu/daily) For CentOS, see the [COPR build repos](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/) -- cgit v1.2.3 From 119990d95c9f764562be071727cfc15eaef2c2ff Mon Sep 17 00:00:00 2001 From: gaughen Date: Fri, 6 Dec 2019 14:43:48 -0800 Subject: removed a couple of "the"s --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 939a5a8e..d648e426 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ Cloud instances are initialized from a disk image and instance data: Cloud-init will identify the cloud it is running on during boot, read any provided metadata from the cloud and initialize the system accordingly. This -may involve setting up the network and storage devices to configuring SSH -access key and many other aspects of a system. Later on the cloud-init will +may involve setting up network and storage devices to configuring SSH +access key and many other aspects of a system. Later on cloud-init will also parse and process any optional user or vendor data that was passed to the instance. -- cgit v1.2.3 From 0562ca696fe1a36b6c3b2fb576068e05033f6f3f Mon Sep 17 00:00:00 2001 From: Adam Dobrawy Date: Mon, 20 Jan 2020 18:34:16 +0100 Subject: Add Rootbox & HyperOne to list of cloud in README (#176) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d648e426..872ea44e 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ get in contact with that distribution and send them our way! | Supported OSes | Supported Public Clouds | Supported Private Clouds | | --- | --- | --- | -| Ubuntu
SLES/openSUSE
RHEL/CentOS
Fedora
Gentoo Linux
Debian
ArchLinux
FreeBSD












| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
Digital Ocean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)















| +| Ubuntu
SLES/openSUSE
RHEL/CentOS
Fedora
Gentoo Linux
Debian
ArchLinux
FreeBSD












| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
Digital Ocean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
HyperOne
Rootbox
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)















| ## To start developing cloud-init -- cgit v1.2.3