From d8b75633aae112d5216211ec6de8fedc49de6350 Mon Sep 17 00:00:00 2001 From: Reyk Floeter Date: Thu, 29 Jun 2017 12:08:38 +0200 Subject: [PATCH] Add README and LICENSE --- LICENSE.md | 30 ++++++++++++++++++++++++++++++ README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..42ee86d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,30 @@ +License +======= + +`agent/` +-------- + +* `cloud-agent` is free software under OpenBSD's ISC-style license. +* Most of the code has been written by Reyk Floeter +* The http.[ch] files have been written by Kristaps Dzonsons +* Please refer to the individual source files for other copyright holders! + +> Copyright (c) 2017 Reyk Floeter +> +> Permission to use, copy, modify, and distribute this software for any +> purpose with or without fee is hereby granted, provided that the above +> copyright notice and this permission notice appear in all copies. +> +> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +> ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +`cms/` +------ + +* The CMS code is from the OpenSSL and/or LibreSSL. +* Please refer to the individual source files for other copyright holders! diff --git a/README.md b/README.md index aba4d47..aa2dde7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,46 @@ -NOTHING TO SEE HERE -=================== +cloud-agent for OpenBSD +======================= -*...yet* +**This is just experimental. Be warned.** + +This is a simple OpenBSD-specific agent that aims to handle +provisioning and cloud initialization on public clouds such as +Microsoft Azure and Amazon AWS. For OpenBSD on Azure, it is a minimal +alternative to the [WALinuxAgent](https://github.com/Azure/WALinuxAgent/). + +Prerequisites +------------- + +* OpenBSD 6.1 or higher, nothing else. + +Files +----- + +* `/usr/local/libexec/cloud-agent` +* `/usr/local/bin/cms` + +The CMS binary is a port of OpenSSL's CMS tool to LibreSSL. LibreSSL +has removed CMS which is required by Azure. + +Usage +----- + +Installation is easy, `cloud-agent` detects the cloud type automatically. + +* On Microsoft Azure, create a file `/etc/hostname.hvn0` + +* On Amazon AWS, create a file `/etc/hostname.xnf0` + +* On OpenBSD VMM (with meta-data), create a file `/etc/hostname.vio0` + +* The content of the fill is identical for all of them: + + dhcp + !/usr/local/libexec/cloud-agent "\$if" + +Author +------ + +[Reyk Floeter](https://github.com/reyk/). + +See the [License](License.md) file for more information.