From 270e3bad8c2f04a715f2e5258eb6ebb7b5b4eae3 Mon Sep 17 00:00:00 2001 From: Vaughn Dice Date: Wed, 19 Feb 2020 15:53:11 -0700 Subject: [PATCH] update docs around examples directory Signed-off-by: Vaughn Dice --- README.md | 11 ++++----- docs/guides/bundle-guide.md | 4 ++-- {examples => drivers/examples}/duffle-foo | 0 examples/helloazure/README.md | 8 ------- examples/helloazure/bundle.json | 12 ---------- examples/helloazure/cnab/app/run | 28 ----------------------- examples/values.toml | 2 -- governance.md | 2 +- 8 files changed, 7 insertions(+), 60 deletions(-) rename {examples => drivers/examples}/duffle-foo (100%) delete mode 100644 examples/helloazure/README.md delete mode 100644 examples/helloazure/bundle.json delete mode 100755 examples/helloazure/cnab/app/run delete mode 100644 examples/values.toml diff --git a/README.md b/README.md index 6ed8b609..51743578 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Duffle: The CNAB Installer -![Build Status](http://badges.technosophos.me/v1/github/build/deislabs/duffle/badge.svg?branch=master) +![Build Status](http://badges.technosophos.me/v1/github/build/cnab/duffle/badge.svg?branch=master) Duffle is the reference implementation of the [CNAB specification][cnab]. It @@ -29,9 +29,6 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md). /home/janedoe/.duffle/credentials ==> The following new files will be created: /home/janedoe/.duffle/repositories.json - ==> Generating a new secret keyring at /home/janedoe/.duffle/secret.ring - ==> Generating a new signing key with ID janedoe - ==> Generating a new public keyring at /home/janedoe/.duffle/public.ring ``` 3. Build and install your first bundle (you can find the `examples` directory in this repository): @@ -72,7 +69,7 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md). ---> Running in d2294cc8b7fd ---> 69abe3476d43 Successfully built 69abe3476d43 - Successfully tagged deislabs/helloworld-cnab:87d786be507769a4913c90d85134c85727c85f41 + Successfully tagged cnab/helloworld-cnab:87d786be507769a4913c90d85134c85727c85f41 ==> Successfully built bundle helloworld:0.1.1 ``` @@ -105,8 +102,8 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md). *Notes:* * To build and install bundles, you need access to a Docker engine - it can be Docker for Mac, Docker for Windows, Docker on Linux, or a remote Docker engine. Duffle uses the Docker engine to build the invocation images, as well as for running actions inside invocation images. * Duffle has a driver architecture for different ways of executing actions inside invocation images, and more drivers will be available in the future. - * Learn more about what a bundle is and its components [here](https://github.com/deislabs/cnab-spec/blob/master/100-CNAB.md). - * Get a feel for what CNAB bundles look like by referencing the [bundles repo](https://github.com/deislabs/bundles) on github. + * Learn more about what a bundle is and its components [here](https://github.com/cnabio/cnab-spec/blob/master/100-CNAB.md). + * Get a feel for what CNAB bundles written for duffle look like by referencing the [examples directory](./examples). ## Developing Duffle diff --git a/docs/guides/bundle-guide.md b/docs/guides/bundle-guide.md index 21c4bcb8..c772c071 100644 --- a/docs/guides/bundle-guide.md +++ b/docs/guides/bundle-guide.md @@ -124,5 +124,5 @@ The output of `duffle install` comes from the run script. `hello world` is print ## Notes and Next steps -- There are alternatives to defining a custom `run` tool. See examples of more complex and different bundles [here](https://github.com/deislabs/bundles). -- Read more about the CNAB spec in the [docs](https://github.com/deislabs/cnab-spec/blob/master/100-CNAB.md) +- There are alternatives to defining a custom `run` tool. See examples of more complex and different bundles [here](../../examples). +- Read more about the CNAB spec in the [docs](https://github.com/cnabio/cnab-spec/blob/master/100-CNAB.md) diff --git a/examples/duffle-foo b/drivers/examples/duffle-foo similarity index 100% rename from examples/duffle-foo rename to drivers/examples/duffle-foo diff --git a/examples/helloazure/README.md b/examples/helloazure/README.md deleted file mode 100644 index 4f63d2de..00000000 --- a/examples/helloazure/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Hello Azure! Use Azure Compute to bootstrap a CNAB - -This is a Duffle bundle that uses a VM to start instead of a container. - -To run: -``` -$ duffle install --driver azvm hello-azure -f helloazure/bundle.json -``` diff --git a/examples/helloazure/bundle.json b/examples/helloazure/bundle.json deleted file mode 100644 index 777dba44..00000000 --- a/examples/helloazure/bundle.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "helloworld", - "version": "0.1.0", - "parameters": {}, - "invocationImages": [ - { - "imageType": "azure-image", - "image": "duffle-dev/duffle-vm-example-0.1.1" - } - ], - "schemaVersion": "v1.0.0-WD" -} \ No newline at end of file diff --git a/examples/helloazure/cnab/app/run b/examples/helloazure/cnab/app/run deleted file mode 100755 index 154cd3b5..00000000 --- a/examples/helloazure/cnab/app/run +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/sh - -#set -eo pipefail - -action=$CNAB_ACTION -name=$CNAB_INSTALLATION_NAME - -case $action in - install) - echo "Install action" - ;; - uninstall) - echo "uninstall action" - ;; - upgrade) - echo "Upgrade action" - ;; - downgrade) - echo "Downgrade action" - ;; - status) - echo "Status action" - ;; - *) - echo "No action for $action" - ;; -esac -echo "Action $action complete for $name" diff --git a/examples/values.toml b/examples/values.toml deleted file mode 100644 index d3b6318a..00000000 --- a/examples/values.toml +++ /dev/null @@ -1,2 +0,0 @@ -name = "value" -second = 2 \ No newline at end of file diff --git a/governance.md b/governance.md index 920cc896..d7eed89a 100644 --- a/governance.md +++ b/governance.md @@ -1,7 +1,7 @@ # Governance ## Project Maintainers -[Project maintainers](CODEOWNERS) are responsible for activities around maintaining and updating Duffle, the reference implementation for the [CNAB spec](https://github.com/deislabs/cnab-spec). Final decisions on the project reside with the project maintainers. +[Project maintainers](CODEOWNERS) are responsible for activities around maintaining and updating Duffle, the reference implementation for the [CNAB spec](https://github.com/cnabio/cnab-spec). Final decisions on the project reside with the project maintainers. Maintainers MUST remain active. If they are unresponsive for >3 months, they will be automatically removed unless a [super-majority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) of the other project maintainers agrees to extend the period to be greater than 3 months.