dev

This development harness creates a monorepo experience for a polyrepo architecture by leveraging git submodules.

Dependencies

OSX Developer Tools, Homebrew, Docker for Mac
aws-vault for logging into AWS
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

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Quick Start

Clone this repo recursively:

git clone --recursive git@github.com:cloudposse/dev.git

Install native dependencies (e.g. chamber and aws-vault)

make deps

Update current submodules in projects/ folder to @HEAD

make git/submodules-update

List available make targets

make help

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

Related Projects

Check out these related projects.

dev - Local Development Environment Example

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!

We offer paid support on all of our projects.

Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman