the default GitOps source repository for booting up Jenkins X
| Révision | d5ff4b9c8784d74aa2929728e6af70ea4846556b (tree) |
|---|---|
| l'heure | 2019-08-29 19:55:16 |
| Auteur | Cosmin Cojocar <cosmin.cojocar@gmx....> |
| Commiter | Cosmin Cojocar |
chore: Update README file
Signed-off-by: Cosmin Cojocar <cosmin.cojocar@gmx.ch>
| @@ -12,9 +12,18 @@ This repository contains the source code for [Jenkins X Boot configuration](http | ||
| 12 | 12 | |
| 13 | 13 | ### Run the new Jenkins X Bootstrap Pipeline |
| 14 | 14 | |
| 15 | -Clone this git repository and make sure you have a recent `jx` binary: | |
| 15 | +Create a fork of this git repository on github. We suggest renaming it to match the pattern `environment-<cluster name>-dev`. To rename your repository go to the repository settings in github. | |
| 16 | 16 | |
| 17 | -From inside the git clone of this repository type: | |
| 17 | +Clone your newly forked git repository: | |
| 18 | + | |
| 19 | +``` | |
| 20 | +git clone https://github.com/<org>/environment-<cluster name>-dev && cd environment-<cluster name>-dev | |
| 21 | +``` | |
| 22 | + | |
| 23 | +> It's important that you cd into your newly checked out git repo, otherwise `jx boot` will use the upstream Jenkins X boot | |
| 24 | +configuration. | |
| 25 | + | |
| 26 | +Now, in the checkout, run: | |
| 18 | 27 | |
| 19 | 28 | ``` |
| 20 | 29 | jx boot |
| @@ -38,11 +47,11 @@ We have improved the support for value + secret composition via this [issue](htt | ||
| 38 | 47 | |
| 39 | 48 | ### Parameters file |
| 40 | 49 | |
| 41 | -We define a [env/parameters.yaml](https://github.com/jstrachan/environment-simple-tekton/blob/master/env/parameters.yaml) file which defines all the parameters either checked in or loaded from Vault or a local file system secrets location. | |
| 50 | +We define a [env/parameters.yaml](https://github.com/jenkins-x/jenkins-x-boot-config/blob/master/env/parameters.yaml) file which defines all the parameters either checked in or loaded from Vault or a local file system secrets location. | |
| 42 | 51 | |
| 43 | 52 | #### Injecting secrets into the parameters |
| 44 | 53 | |
| 45 | -If you look at the current [env/parameters.yaml](https://github.com/jstrachan/environment-simple-tekton/blob/master/env/parameters.yaml) file you will see some values inlined and others use URIs of the form `local:my-cluster-folder/nameofSecret/key`. This currently supports 2 schemes: | |
| 54 | +If you look at the current [env/parameters.yaml](https://github.com/jenkins-x/jenkins-x-boot-config/blob/master/env/parameters.yaml) file you will see some values inlined and others use URIs of the form `local:my-cluster-folder/nameofSecret/key`. This currently supports 2 schemes: | |
| 46 | 55 | |
| 47 | 56 | * `vault:` to load from a path + key from Vault |
| 48 | 57 | * `local:` to load from a key in a YAML file at `~/.jx/localSecrets/$path.yml` |
hylom
Fork
jenkins-x/jenkins-x-boot-config
README.md