Skip to content

Commit

Permalink
Merge pull request #189 from bgilbert/afterburn
Browse files Browse the repository at this point in the history
*: rename to Afterburn
  • Loading branch information
bgilbert authored Mar 27, 2019
2 parents 5289e06 + 16f7eb6 commit 8a3079c
Show file tree
Hide file tree
Showing 18 changed files with 140 additions and 132 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
name: Bug report
about: Report an issue with coreos-metadata
about: Report an issue with Afterburn
---

# Bug #

## Operating System Version ##

## coreos-metadata Version ##
## Afterburn Version ##

## Environment ##

What hardware/cloud provider/hypervisor is being used to run coreos-metadata?
What hardware/cloud provider/hypervisor is being used to run Afterburn?

## Expected Behavior ##

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: Feature request
about: Suggest an enhancement to coreos-metadata
about: Suggest an enhancement to Afterburn
---

# Feature Request #

## Environment ##

What hardware/cloud provider/hypervisor is being used to run coreos-metadata?
What hardware/cloud provider/hypervisor is being used to run Afterburn?

## Desired Feature ##

Expand Down
62 changes: 31 additions & 31 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[package]
name = "coreos-metadata"
repository = "https://github.com/coreos/coreos-metadata"
name = "afterburn"
repository = "https://github.com/coreos/afterburn"
license = "Apache-2.0"
authors = [ "Stephen Demos <[email protected]>",
"Luca Bruno <[email protected]>" ]
description = "A simple cloud-provider metadata agent"
description = "A simple cloud provider agent"
version = "3.1.1-alpha.0"

[[bin]]
name = "coreos-metadata"
name = "afterburn"
path = "src/main.rs"

[profile.release]
Expand Down Expand Up @@ -54,7 +54,7 @@ sign-commit = true
upload-doc = false
disable-push = true
disable-publish = true
pre-release-commit-message = "cargo: coreos-metadata release {{version}}"
pre-release-commit-message = "cargo: Afterburn release {{version}}"
pro-release-commit-message = "cargo: version bump to {{version}}"
tag-message = "coreos-metadata v{{version}}"
tag-message = "Afterburn v{{version}}"
tag-prefix = "v"
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ PREFIX ?= /usr

DEFAULT_INSTANCE ?= core

units = $(addprefix systemd/,coreos-metadata.service coreos-metadata[email protected])
units = $(addprefix systemd/,afterburn.service afterburn[email protected])

%.service: %.service.in
sed -e 's,@DEFAULT_INSTANCE@,'$(DEFAULT_INSTANCE)',' < $< > $@.tmp && mv $@.tmp $@
Expand Down
108 changes: 54 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# coreos-metadata
# Afterburn

[![Build Status](https://travis-ci.org/coreos/coreos-metadata.svg?branch=master)](https://travis-ci.org/coreos/coreos-metadata)
[![Build Status](https://travis-ci.org/coreos/afterburn.svg?branch=master)](https://travis-ci.org/coreos/afterburn)
![minimum rust 1.29](https://img.shields.io/badge/rust-1.29%2B-orange.svg)

This is a small utility, typically used in conjunction with [Ignition][ignition], which reads metadata from a given cloud-provider and applies it to the system.
This can include adding SSH keys and writing cloud-specific attributes into an environment file (e.g. `/run/metadata/coreos`), which can then be consumed by systemd service units via `EnvironmentFile=`.
This can include adding SSH keys and writing cloud-specific attributes into an environment file (e.g. `/run/metadata/afterburn`), which can then be consumed by systemd service units via `EnvironmentFile=`.

## Support

Expand All @@ -14,87 +14,87 @@ On CoreOS Container Linux, the supported providers and metadata are [somewhat di
- aws
- SSH Keys
- Attributes
- COREOS_AWS_HOSTNAME
- COREOS_AWS_PUBLIC_HOSTNAME
- COREOS_AWS_IPV4_LOCAL
- COREOS_AWS_IPV4_PUBLIC
- COREOS_AWS_AVAILABILITY_ZONE
- COREOS_AWS_INSTANCE_ID
- COREOS_AWS_REGION
- AFTERBURN_AWS_HOSTNAME
- AFTERBURN_AWS_PUBLIC_HOSTNAME
- AFTERBURN_AWS_IPV4_LOCAL
- AFTERBURN_AWS_IPV4_PUBLIC
- AFTERBURN_AWS_AVAILABILITY_ZONE
- AFTERBURN_AWS_INSTANCE_ID
- AFTERBURN_AWS_REGION
- azure
- SSH Keys
- Attributes
- COREOS_AZURE_IPV4_DYNAMIC
- COREOS_AZURE_IPV4_VIRTUAL
- AFTERBURN_AZURE_IPV4_DYNAMIC
- AFTERBURN_AZURE_IPV4_VIRTUAL
- cloudstack-configdrive
- SSH Keys
- Attributes
- COREOS_CLOUDSTACK_AVAILABILITY_ZONE
- COREOS_CLOUDSTACK_INSTANCE_ID
- COREOS_CLOUDSTACK_SERVICE_OFFERING
- COREOS_CLOUDSTACK_CLOUD_IDENTIFIER
- COREOS_CLOUDSTACK_LOCAL_HOSTNAME
- COREOS_CLOUDSTACK_VM_ID
- AFTERBURN_CLOUDSTACK_AVAILABILITY_ZONE
- AFTERBURN_CLOUDSTACK_INSTANCE_ID
- AFTERBURN_CLOUDSTACK_SERVICE_OFFERING
- AFTERBURN_CLOUDSTACK_CLOUD_IDENTIFIER
- AFTERBURN_CLOUDSTACK_LOCAL_HOSTNAME
- AFTERBURN_CLOUDSTACK_VM_ID
- cloudstack-metadata
- SSH Keys
- Attributes
- COREOS_CLOUDSTACK_AVAILABILITY_ZONE
- COREOS_CLOUDSTACK_CLOUD_IDENTIFIER
- COREOS_CLOUDSTACK_HOSTNAME
- COREOS_CLOUDSTACK_INSTANCE_ID
- COREOS_CLOUDSTACK_IPV4_LOCAL
- COREOS_CLOUDSTACK_IPV4_PUBLIC
- COREOS_CLOUDSTACK_LOCAL_HOSTNAME
- COREOS_CLOUDSTACK_PUBLIC_HOSTNAME
- COREOS_CLOUDSTACK_SERVICE_OFFERING
- COREOS_CLOUDSTACK_VM_ID
- AFTERBURN_CLOUDSTACK_AVAILABILITY_ZONE
- AFTERBURN_CLOUDSTACK_CLOUD_IDENTIFIER
- AFTERBURN_CLOUDSTACK_HOSTNAME
- AFTERBURN_CLOUDSTACK_INSTANCE_ID
- AFTERBURN_CLOUDSTACK_IPV4_LOCAL
- AFTERBURN_CLOUDSTACK_IPV4_PUBLIC
- AFTERBURN_CLOUDSTACK_LOCAL_HOSTNAME
- AFTERBURN_CLOUDSTACK_PUBLIC_HOSTNAME
- AFTERBURN_CLOUDSTACK_SERVICE_OFFERING
- AFTERBURN_CLOUDSTACK_VM_ID
- digitalocean
- SSH Keys
- Network Configs
- Attributes
- COREOS_DIGITALOCEAN_HOSTNAME
- COREOS_DIGITALOCEAN_IPV4_ANCHOR_0
- COREOS_DIGITALOCEAN_IPV4_PUBLIC_0
- COREOS_DIGITALOCEAN_IPV4_PRIVATE_0
- COREOS_DIGITALOCEAN_IPV6_PUBLIC_0
- COREOS_DIGITALOCEAN_IPV6_PRIVATE_0
- COREOS_DIGITALOCEAN_REGION
- AFTERBURN_DIGITALOCEAN_HOSTNAME
- AFTERBURN_DIGITALOCEAN_IPV4_ANCHOR_0
- AFTERBURN_DIGITALOCEAN_IPV4_PUBLIC_0
- AFTERBURN_DIGITALOCEAN_IPV4_PRIVATE_0
- AFTERBURN_DIGITALOCEAN_IPV6_PUBLIC_0
- AFTERBURN_DIGITALOCEAN_IPV6_PRIVATE_0
- AFTERBURN_DIGITALOCEAN_REGION
- gcp
- SSH Keys
- Attributes
- COREOS_GCP_HOSTNAME
- COREOS_GCP_IP_EXTERNAL_0
- COREOS_GCP_IP_LOCAL_0
- AFTERBURN_GCP_HOSTNAME
- AFTERBURN_GCP_IP_EXTERNAL_0
- AFTERBURN_GCP_IP_LOCAL_0
- openstack-metadata
- SSH Keys
- Attributes
- COREOS_OPENSTACK_HOSTNAME
- COREOS_OPENSTACK_IPV4_LOCAL
- COREOS_OPENSTACK_IPV4_PUBLIC
- COREOS_OPENSTACK_INSTANCE_ID
- AFTERBURN_OPENSTACK_HOSTNAME
- AFTERBURN_OPENSTACK_IPV4_LOCAL
- AFTERBURN_OPENSTACK_IPV4_PUBLIC
- AFTERBURN_OPENSTACK_INSTANCE_ID
- packet
- SSH Keys
- Network Configs
- Attributes
- COREOS_PACKET_HOSTNAME
- COREOS_PACKET_IPV4_PUBLIC_0
- COREOS_PACKET_IPV4_PRIVATE_0
- COREOS_PACKET_IPV6_PUBLIC_0
- AFTERBURN_PACKET_HOSTNAME
- AFTERBURN_PACKET_IPV4_PUBLIC_0
- AFTERBURN_PACKET_IPV4_PRIVATE_0
- AFTERBURN_PACKET_IPV6_PUBLIC_0
- vagrant-virtualbox
- Attributes
- COREOS_VAGRANT_VIRTUALBOX_PRIVATE_IPV4
- COREOS_VAGRANT_VIRTUALBOX_HOSTNAME
- AFTERBURN_VAGRANT_VIRTUALBOX_PRIVATE_IPV4
- AFTERBURN_VAGRANT_VIRTUALBOX_HOSTNAME

Additionally, some attribute names are reserved for usage by [custom metadata providers][custom-metadata].
These can be safely used by external providers on a platform not supported by coreos-metadata:
These can be safely used by external providers on a platform not supported by Afterburn:

- custom
- Attributes
- COREOS_CUSTOM_HOSTNAME
- COREOS_CUSTOM_PUBLIC_IPV4
- COREOS_CUSTOM_PRIVATE_IPV4
- COREOS_CUSTOM_PUBLIC_IPV6
- COREOS_CUSTOM_PRIVATE_IPV6
- AFTERBURN_CUSTOM_HOSTNAME
- AFTERBURN_CUSTOM_PUBLIC_IPV4
- AFTERBURN_CUSTOM_PRIVATE_IPV4
- AFTERBURN_CUSTOM_PUBLIC_IPV6
- AFTERBURN_CUSTOM_PRIVATE_IPV6

[ignition]: https://github.com/coreos/ignition
[custom-metadata]: https://github.com/coreos/container-linux-config-transpiler/blob/v0.8.0/doc/dynamic-data.md#custom-metadata-providers
Expand Down
8 changes: 5 additions & 3 deletions docs/container-linux-legacy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# coreos-metadata on CoreOS Container Linux
# Afterburn on CoreOS Container Linux

This is a small utility, typically used in conjunction with [Ignition][ignition], which reads metadata from a given cloud-provider and applies it to the system.
This can include adding SSH keys and writing cloud-specific attributes into an environment file (e.g. `/run/metadata/coreos`), which can then be consumed by systemd service units via `EnvironmentFile=`.

coreos-metadata can be built with the `cl-legacy` feature to enable legacy behavior for Container Linux.
On Container Linux, for historical reasons, Afterburn is usually called "coreos-metadata".

Afterburn can be built with the `cl-legacy` feature to enable legacy behavior for Container Linux.
Other distros should not enable this feature.

## Support
Expand Down Expand Up @@ -85,7 +87,7 @@ On Container Linux, the supported cloud providers and their respective metadata
- COREOS_VAGRANT_VIRTUALBOX_HOSTNAME

Additionally, some attribute names are reserved for usage by [custom metadata providers][custom-metadata].
These can be safely used by external providers on a platform not supported by coreos-metadata:
These can be safely used by external providers on a platform not supported by Afterburn:

- custom
- Attributes
Expand Down
6 changes: 3 additions & 3 deletions docs/distro.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Integrating coreos-metadata into a distribution
# Integrating Afterburn into a distribution

## SSH keys

The `--ssh-keys` option (invoked by `coreos-metadata-[email protected]`) writes SSH keys to `~user/.ssh/authorized_keys.d/coreos-metadata`.
The `--ssh-keys` option (invoked by `afterburn-[email protected]`) writes SSH keys to `~user/.ssh/authorized_keys.d/afterburn`.
For sshd to respect this file, it must be configured with an `AuthorizedKeysCommand` that reads files from the `authorized_keys.d` directory.
Alternatively, sshd can be configured to read the fragment file directly:

```
AuthorizedKeysFile .ssh/authorized_keys .ssh/authorized_keys.d/coreos-metadata
AuthorizedKeysFile .ssh/authorized_keys .ssh/authorized_keys.d/afterburn
```
2 changes: 1 addition & 1 deletion docs/release-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For each release to be published, proceed as follows:
#### 6. Assemble vendor tarball and publish a Release

* `cargo vendor`
* `tar -czf target/coreos-metadata-${RELEASE_VER}-vendor.tar.gz vendor`
* `tar -czf target/afterburn-${RELEASE_VER}-vendor.tar.gz vendor`
* Open a web browser and create a GitHub Release for the tag above
* Attach the `vendor.tar.gz` (located under `target/`) to the current Release
* Write a short changelog and publish the Release
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ fn init() -> Result<Config> {
// prepends the hyphens
// the preprocessing will probably convert any short flags it finds into
// long ones
let matches = App::new("coreos-metadata")
let matches = App::new("Afterburn")
.version(crate_version!())
.arg(
Arg::with_name("attributes")
Expand Down
2 changes: 1 addition & 1 deletion src/providers/azure/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ static HDR_VERSION: &str = "x-ms-version";
static HDR_CIPHER_NAME: &str = "x-ms-cipher-name";
static HDR_CERT: &str = "x-ms-guest-agent-public-x509-cert";

const MS_AGENT_NAME: &str = "com.coreos.metadata";
const MS_AGENT_NAME: &str = "com.coreos.afterburn";
const MS_VERSION: &str = "2012-11-30";
const SMIME_HEADER: &str = "\
MIME-Version:1.0
Expand Down
2 changes: 1 addition & 1 deletion src/providers/cloudstack/configdrive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ impl ConfigDrive {

// if not try and mount with each of the labels
let target =
TempDir::new("coreos-metadata").chain_err(|| "failed to create temporary directory")?;
TempDir::new("afterburn").chain_err(|| "failed to create temporary directory")?;
ConfigDrive::mount_ro(
&Path::new("/dev/disk/by-label/").join(CONFIG_DRIVE_LABEL_1),
target.path(),
Expand Down
Loading

0 comments on commit 8a3079c

Please sign in to comment.