Skip to content

Commit

Permalink
adding docs on the manifest configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
eamonnfaherty committed Apr 23, 2019
1 parent 9a85222 commit e837fa8
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 2 deletions.
84 changes: 83 additions & 1 deletion docs/source/puppet/designing_your_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,89 @@ At the moment there are the following macros supported:
```

### Accounts
Description coming soon

With the accounts section, you can describe your AWS accounts. You can set a default region, the enabled regions and
you can tag your accounts. This metadata describing your account is used to determine which packages get deployed into
your accounts.

#### Setting a default region
Within your account you may have a _home_ or a default region. This may be the closest region to the team using the
account. You use ```default_region``` when describing your account and then you can use ```default_region``` again as a
target when you specify your product launches - the product will be provisioned into the region specified.

Here is an example with a ```default_region``` set to ```us-east-1```:

```yaml
schema: puppet-2019-04-01

accounts:
- account_id: '<YOUR_ACCOUNT_ID>'
name: '<YOUR_ACCOUNT_NAME>'
default_region: us-east-1
regions_enabled:
- us-east-1
- us-west-2
tags:
- type:prod
- partition:us
- scope:pci
```

Please note ```default_region``` can only be a string.

#### Setting enabled regions
You may chose not to use every region within your AWS Account. When describing an AWS account you can specify which
regions are enabled for an account using ```regions_enabled```.

Here is an example with ```regions_enabled``` set to ```us-east-1 and us-west-2```:

```yaml
schema: puppet-2019-04-01

accounts:
- account_id: '<YOUR_ACCOUNT_ID>'
name: '<YOUR_ACCOUNT_NAME>'
default_region: us-east-1
regions_enabled:
- us-east-1
- us-west-2
tags:
- type:prod
- partition:us
- scope:pci
```

Please note ```regions_enabled``` can only be a list of strings.


#### Setting tags
You can describe your account using tags. Tags are specified using a list of strings. We recommend using namespaces
for your tags, adding an extra dimension to them. If you choose to do this you can use a colon to split name and values.

Here is an example with namespaced tags:

```yaml
schema: puppet-2019-04-01

accounts:
- account_id: '<YOUR_ACCOUNT_ID>'
name: '<YOUR_ACCOUNT_NAME>'
default_region: us-east-1
regions_enabled:
- us-east-1
- us-west-2
tags:
- type:prod
- partition:us
- scope:pci
```

In this example there the following tags:
- namespace of type and value of prod
- namespace of partition and value of us
- namespace of scope and value of pci.

The goal of tags is to provide a classification for your accounts that can be used to a deployment time.

### Launches
Description coming soon
Expand Down
3 changes: 2 additions & 1 deletion docs/source/puppet/getting_up_and_running.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,12 @@ servicecatalog-puppet bootstrap
```

### Setup your puppet
Clone the configuration repo and configure your factory:
Clone the configuration repo and configure your factory by editing the ```manifest.yaml``` file:
```bash
git clone --config 'credential.helper=!aws codecommit credential-helper $@' --config 'credential.UseHttpPath=true' https://git-codecommit.eu-west-1.amazonaws.com/v1/repos/ServiceCatalogPuppet
servicecatalog-puppet seed simple ServiceCatalogPuppet
cd ServiceCatalogPuppet
vim manifest.yaml
git add .
git commit -am "initial add"
git push
Expand Down

0 comments on commit e837fa8

Please sign in to comment.