From 008ca51fec3a19a3d2f864f449c3fc8399a78f0c Mon Sep 17 00:00:00 2001 From: Jake Lundberg Date: Mon, 11 Jun 2018 12:42:14 -0700 Subject: [PATCH 1/2] add-pki-guide: updating readme --- secrets/pki/vagrant/.gitignore | 5 + secrets/pki/vagrant/CONTRIBUTING.md | 71 ++++ secrets/pki/vagrant/DCO | 36 ++ secrets/pki/vagrant/LICENSE | 202 ++++++++++ secrets/pki/vagrant/MAINTAINERS | 3 + secrets/pki/vagrant/NOTICE | 5 + secrets/pki/vagrant/README.md | 186 +++++++++ secrets/pki/vagrant/Vagrantfile | 145 +++++++ secrets/pki/vagrant/demo/clean_demo.sh | 13 + secrets/pki/vagrant/demo/default_env.sh | 61 +++ secrets/pki/vagrant/demo/demo-magic.sh | 200 ++++++++++ .../demo/demo1_bootstrap_environment.sh | 103 +++++ secrets/pki/vagrant/demo/demo2_short_ttls.sh | 38 ++ secrets/pki/vagrant/demo/demo3_renew_lease.sh | 24 ++ secrets/pki/vagrant/demo/demo4_revoke_cert.sh | 14 + .../demo/demo5_consul_template_renew.sh | 39 ++ .../demo/tokens/short-ttl-hashidemos-com | 4 + .../pki/vagrant/demo/vault_demo_functions.sh | 361 ++++++++++++++++++ secrets/pki/vagrant/run_me_first.sh | 152 ++++++++ 19 files changed, 1662 insertions(+) create mode 100644 secrets/pki/vagrant/.gitignore create mode 100644 secrets/pki/vagrant/CONTRIBUTING.md create mode 100644 secrets/pki/vagrant/DCO create mode 100644 secrets/pki/vagrant/LICENSE create mode 100644 secrets/pki/vagrant/MAINTAINERS create mode 100644 secrets/pki/vagrant/NOTICE create mode 100644 secrets/pki/vagrant/README.md create mode 100644 secrets/pki/vagrant/Vagrantfile create mode 100755 secrets/pki/vagrant/demo/clean_demo.sh create mode 100644 secrets/pki/vagrant/demo/default_env.sh create mode 100644 secrets/pki/vagrant/demo/demo-magic.sh create mode 100755 secrets/pki/vagrant/demo/demo1_bootstrap_environment.sh create mode 100755 secrets/pki/vagrant/demo/demo2_short_ttls.sh create mode 100755 secrets/pki/vagrant/demo/demo3_renew_lease.sh create mode 100755 secrets/pki/vagrant/demo/demo4_revoke_cert.sh create mode 100755 secrets/pki/vagrant/demo/demo5_consul_template_renew.sh create mode 100644 secrets/pki/vagrant/demo/tokens/short-ttl-hashidemos-com create mode 100644 secrets/pki/vagrant/demo/vault_demo_functions.sh create mode 100755 secrets/pki/vagrant/run_me_first.sh diff --git a/secrets/pki/vagrant/.gitignore b/secrets/pki/vagrant/.gitignore new file mode 100644 index 00000000..486a479b --- /dev/null +++ b/secrets/pki/vagrant/.gitignore @@ -0,0 +1,5 @@ +provision.sh +user-data +.vagrant* +demo/initial_root_token +demo/vault_init_output.txt diff --git a/secrets/pki/vagrant/CONTRIBUTING.md b/secrets/pki/vagrant/CONTRIBUTING.md new file mode 100644 index 00000000..6662073a --- /dev/null +++ b/secrets/pki/vagrant/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# How to Contribute + +CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via +GitHub pull requests. This document outlines some of the conventions on +development workflow, commit message formatting, contact points and other +resources to make it easier to get your contribution accepted. + +# Certificate of Origin + +By contributing to this project you agree to the Developer Certificate of +Origin (DCO). This document was created by the Linux Kernel community and is a +simple statement that you, as a contributor, have the legal right to make the +contribution. See the [DCO](DCO) file for details. + +# Email and Chat + +The project currently uses the general CoreOS email list and IRC channel: +- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev) +- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org + +Please avoid emailing maintainers found in the MAINTAINERS file directly. They +are very busy and read the mailing lists. + +## Getting Started + +- Fork the repository on GitHub +- Read the [README](README.md) for build and test instructions +- Play with the project, submit bugs, submit patches! + +## Contribution Flow + +This is a rough outline of what a contributor's workflow looks like: + +- Create a topic branch from where you want to base your work (usually master). +- Make commits of logical units. +- Make sure your commit messages are in the proper format (see below). +- Push your changes to a topic branch in your fork of the repository. +- Make sure the tests pass, and add any new tests as appropriate. +- Submit a pull request to the original repository. + +Thanks for your contributions! + +### Format of the Commit Message + +We follow a rough convention for commit messages that is designed to answer two +questions: what changed and why. The subject line should feature the what and +the body of the commit should describe the why. + +``` +scripts: add the test-cluster command + +this uses tmux to setup a test cluster that you can easily kill and +start for debugging. + +Fixes #38 +``` + +The format can be described more formally as follows: + +``` +: + + + +