-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2edd952
commit da8f3ac
Showing
2 changed files
with
275 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| --- | ||
| # | ||
| # This is the canonical configuration for the `README.md` | ||
| # Run `make readme` to rebuild the `README.md` | ||
| # | ||
|
|
||
| # Name of this project | ||
| name: dev | ||
|
|
||
| # Logo for this project | ||
| #logo: docs/logo.png | ||
|
|
||
| # License of this project | ||
| license: "APACHE2" | ||
|
|
||
| # Canonical GitHub repo | ||
| github_repo: cloudposse/dev | ||
|
|
||
| # Badges to display | ||
| badges: | ||
| - name: "Build Status" | ||
| image: "https://travis-ci.org/cloudposse/dev.svg?branch=master" | ||
| url: "https://travis-ci.org/cloudposse/dev" | ||
| - name: "Latest Release" | ||
| image: "https://img.shields.io/github/release/cloudposse/dev.svg" | ||
| url: "https://travis-ci.org/cloudposse/dev/releases" | ||
| - name: "Slack Community" | ||
| image: "https://slack.cloudposse.com/badge.svg" | ||
| url: "https://slack.cloudposse.com" | ||
|
|
||
| related: | ||
| - name: "dev" | ||
| description: "Local Development Environment Example" | ||
| url: "https://github.com/cloudposse/local-dev-scaffolding" | ||
|
|
||
| # Short description of this project | ||
| description: |- | ||
| This development harness creates a [monorepo](https://docs.cloudposse.com/glossary/monorepo/) experience for a [polyrepo](https://docs.cloudposse.com/glossary/polyrepo/) architecture by leveraging [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). | ||
| ## Dependencies | ||
| * [OSX Developer Tools, Homebrew, Docker for Mac](https://docs.cloudposse.com/local-dev-environments/quickstart/) | ||
| * [aws-vault](https://docs.cloudposse.com/tools/aws-vault/) for logging into AWS | ||
| * [chamber](https://docs.cloudposse.com/tools/chamber/) for accessing development secrets | ||
| ## Layout | ||
| ``` | ||
| ├── Makefile # Task runner for all commands | ||
| ├── README.md # Getting started documentation | ||
| ├── docker-compose.yml # Master compose environment | ||
| ├── projects/ # Local checkout of all cloudposse repos supported by the local dev environment | ||
| │ ├── docs/ # Checkout of https://github.com/cloudposse/docs | ||
| │ ├── geodesic/ # Checkout of https://github.com/cloudposse/geodesic | ||
| │ ├── containers/ # Projects that provide docker images | ||
| │ ├── terraform/ # Projects geared towards terraform modules | ||
| │ ├── kubernetes/ # Projects geared towards kubernetes | ||
| │ └── tools/ # Projects that provide some utility | ||
| └── tasks/ # Make targets used for | ||
| ├── Makefile.git # Targets for interacting with git | ||
| └── Makefile.projects # Targets for working with projects | ||
| ``` | ||
| quickstart: |- | ||
| Clone [this repo](https://github.com/cloudposse/dev/) recursively: | ||
| ``` | ||
| git clone --recursive git@github.com:cloudposse/dev.git | ||
| ``` | ||
| Initialize the [`build-harness`](https://github.com/cloudposse/build-harness): | ||
| ``` | ||
| make init | ||
| ``` | ||
| Install native dependencies (e.g. `chamber` and `aws-vault`) | ||
| ``` | ||
| make deps | ||
| ``` | ||
| Update current submodules in `projects/` folder to `@HEAD` | ||
| ``` | ||
| make git/update | ||
| ``` | ||
| List available `make` targets | ||
| ``` | ||
| make help | ||
| ``` | ||
| Bring up a complete environment: (*without* secrets) | ||
| ``` | ||
| make compose/up | ||
| ``` | ||
| Bring up a complete environment: (*with* secrets) | ||
| ``` | ||
| aws-vault exec cp-dev-admin -- chamber exec local -- make compose/up | ||
| ``` | ||
| **NOTE**: `local` represents a secrets service namespace. Multiple namespaces can be specified. | ||
| Destroy current environment: | ||
| ``` | ||
| make compose/down | ||
| ``` | ||
| ## Submodules | ||
| Add a new submodule: | ||
| ``` | ||
| git submodule add git@github.com:cloudposse/example.git projects/example/ | ||
| ``` | ||
| Initialize a module (e.g. after calling `git submodule add`): | ||
| ``` | ||
| git -C projects/example/ submodule update --init | ||
| ``` | ||
| # Contributors to this project | ||
| contributors: | ||
| - name: "Erik Osterman" | ||
| github: "osterman" |