meissa/dda-devops-build
6
1
Fork 0
Code Issues Pull requests Projects Releases 33 Packages Wiki Activity

update doc

Browse source
This commit is contained in:
jem 2020-04-16 18:40:51 +02:00
parent 8e194e53a2
commit cd919357cd
1 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -2,7 +2,19 @@
[![Slack](https://img.shields.io/badge/chat-clojurians-green.svg?style=flat)](https://clojurians.slack.com/messages/#dda-pallet/) | [<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org) [![Slack](https://img.shields.io/badge/chat-clojurians-green.svg?style=flat)](https://clojurians.slack.com/messages/#dda-pallet/) | [<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org)
dda-devops-build provide a envioronment to tie several DevOps tools together for easy interoperation. Supported tools are:
* aws with
* simple api-key auth
* mfa & assume-role auth
* hetzner with simple api-key auth
* terraform v0.11, v0.12 supporting
* local file backends
* s3 backends
* user / team credentials managed by gopass
* dda-pallet
# Setup # Setup
``` ```
sudo apt install python3-pip sudo apt install python3-pip
sudo pip3 install pip3 --upgrade --user sudo pip3 install pip3 --upgrade --user
@ -14,9 +26,13 @@ pip3 install python-terraform --user
# in case of using AwsMixin # in case of using AwsMixin
pip3 install boto3 --user pip3 install boto3 --user
# in case of using AwsMfaMixin
pip3 install boto3 mfa --user
``` ```
# Example Build # Example Build
lets assume the following poject structure lets assume the following poject structure
``` ```
@ -79,6 +95,7 @@ def tf_import(project):
``` ```
## Feature aws-backend ## Feature aws-backend
Will use a file `backend.dev.live.properties` where dev is the [account-name], live is the [stage]. Will use a file `backend.dev.live.properties` where dev is the [account-name], live is the [stage].
the backend.dev.live.properties file content: the backend.dev.live.properties file content:
@ -111,6 +128,7 @@ def initialize(project):
``` ```
## Feature aws-mfa-assume-role ## Feature aws-mfa-assume-role
In order to use aws assume role in combination with the mfa-tool (`pip install mfa`): In order to use aws assume role in combination with the mfa-tool (`pip install mfa`):
the build.py file content: the build.py file content:
@ -142,13 +160,15 @@ def access(project):
build.get_mfa_session() build.get_mfa_session()
``` ```
# Snapshot # Releasing and updating
## Publish snapshot
1. pyb publish upload 1. pyb publish upload
2. Versions nr in build.py: hochzählen, *.dev0 anfügen 2. Versions nr in build.py: hochzählen, *.dev0 anfügen
3. sudo pip3 install --pre ddadevops==0.5.0.dev0 --user 3. sudo pip3 install --pre ddadevops==0.5.0.dev0 --user
# Release ## Release
1. Versions nr in build.py: *.dev0 entfernen 1. Versions nr in build.py: *.dev0 entfernen
1. git commit -am "release" 1. git commit -am "release"
2. git tag [version] 2. git tag [version]
@ -159,10 +179,10 @@ def access(project):
8. git push 8. git push
9. sudo pip3 install ddadevops==0.5.0 --user 9. sudo pip3 install ddadevops==0.5.0 --user
# Update to newest dev version ## Update to newest dev version
pip3 install --pre ddadevops==0.5.0.dev0 --user pip3 install --pre ddadevops==0.5.0.dev0 --user
## License # License
Copyright © 2019 meissa GmbH Copyright © 2019 meissa GmbH
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License") Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")