Updating readme

CD_ASBC-B2VAUTH
Patryk Gudalewicz 2023-01-26 09:26:31 +01:00
parent 66058fef38
commit 5ad7b30cd3
1 changed files with 12 additions and 6 deletions

View File

@ -11,26 +11,28 @@ Before executing scripts, python requirements have to be satisfied. To do so, ex
1. Clone template: 1. Clone template:
git clone --branch template https://atc.bmwgroup.net/bitbucket/scm/opapm/coco_apm_terraform_onboarding.git git clone --branch template https://atc.bmwgroup.net/bitbucket/scm/opapm/coco_apm_terraform_onboarding.git
2. Create branch: 2. Change directory:
cd coco_apm_terraform_onboarding
3. Create branch:
git checkout -b CD_<appname> git checkout -b CD_<appname>
3.Install python dependencies: 4.Install python dependencies:
pip install -r requirements.txt pip install -r requirements.txt
4.Run onboarding script: 5.Run onboarding script:
4.1 Default implementation (Management zone, Alerting profile and predefined dashboard) 4.1 Default implementation (Management zone, Alerting profile and predefined dashboard)
python ./onboarding.py -A CD_<app_name> -C <compass_id> python ./onboarding.py -A CD_<app_name> -C <compass_id>
4.2 Additional features (see Usage section): 4.2 Additional features (see Usage section):
python ./onboarding.py -A CD_<app_name> -C <compass_id> -F <features> python ./onboarding.py -A CD_<app_name> -C <compass_id> -F <features>
5. Review created files: 6. Review created files:
git status git status
5.1 Adjust additional feature files (if generated with "-F" option). See "Adjusting tf files" section 5.1 Adjust additional feature files (if generated with "-F" option). See "Adjusting tf files" section
6. Commit your changes: 7. Commit your changes:
git add <changes> git add <changes>
git commit -m "<OPMAAS-XXX> - Add initial configuration of application <app_name> to Dynatrace" git commit -m "<OPMAAS-XXX> - Add initial configuration of application <app_name> to Dynatrace"
git push -u origin CD_<app_name> git push -u origin CD_<app_name>
7. Create pull request from CD_<app_name> to master 8. Create pull request from CD_<app_name> to master
# Adjusting tf files # Adjusting tf files
@ -60,6 +62,10 @@ For more information about adjusting tf files to your need please follow:
# Files # Files
## _templates folder
Please do not change template files inside this folder. If any of this files will be changed, your pull request will be rejected.
## onboarding.py ## onboarding.py
This scripts generates predefined configuration basing on your app_name and compass ids This scripts generates predefined configuration basing on your app_name and compass ids