Skip to content

Commit fda0396

Browse files
committed
Add a tree view with descriptions of important files
1 parent c69edad commit fda0396

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,29 @@ The important files and items in this template are as follows:
2323
* A config_version script.
2424
* An example [config_version](https://puppet.com/docs/puppet/5.3/config_file_environment.html#configversion) script that outputs the git commit ID of the code that was used during a Puppet run.
2525

26+
Here's a visual representation of the structure of this repository:
27+
28+
```
29+
control-repo/
30+
├── data/ # Hiera data directory.
31+
│   ├── nodes/ # Node-specific data goes here.
32+
│   └── common.yaml # Common data goes here.
33+
├── manifests/
34+
│   └── site.pp # The "main" manifest that contains a default node definition.
35+
├── scripts/
36+
│   ├── code_manager_config_version.rb # A config_version script for Code Manager.
37+
│   ├── config_version.rb # A config_version script for r10k.
38+
│   └── config_version.sh # A wrapper that chooses the appropriate config_version script.
39+
├── site/ # This directory contains site-specific modules and is added to $modulepath.
40+
│   ├── profile/ # The profile module.
41+
│   └── role/ # The role module.
42+
├── LICENSE
43+
├── Puppetfile # A list of external Puppet modules to deploy with an environment.
44+
├── README.md
45+
├── environment.conf # Environment-specific settings. Configures the moduelpath and config_version.
46+
└── hiera.yaml # Hiera's configuration file. The Hiera hierarchy is defined here.
47+
```
48+
2649
## Copy This Repo Into Your Own Git Server
2750

2851
To get started with using the control-repo template in your own environment and git server, we've provided steps for the three most common servers we see: [GitLab](#gitlab), [BitBucket](#bitbucketstash), and [GitHub](#github).

0 commit comments

Comments
 (0)