From 33d05cfb94b53b804d7da0c43cda576d8db386a1 Mon Sep 17 00:00:00 2001 From: Michael Jerger Date: Fri, 2 Jun 2023 17:21:37 +0200 Subject: [PATCH] [skip-ci] update doc --- doc/DevopsBuild.md | 10 +++- doc/{ => dev}/dev_setup.md | 0 doc/{ => dev}/releasing.md | 0 .../backend.prod.int.properties | 4 -- doc/example/20_terrform_1_0/build.py | 55 ------------------- doc/example/20_terrform_1_0/route.tf | 7 --- doc/example/50_docker_module/build.py | 42 -------------- doc/example/50_docker_module/image/Dockerfile | 1 - .../image/resources/install.sh | 13 ----- doc/example/50_docker_module/test/Dockerfile | 7 --- .../50_docker_module/test/serverspec.edn | 1 - 11 files changed, 8 insertions(+), 132 deletions(-) rename doc/{ => dev}/dev_setup.md (100%) rename doc/{ => dev}/releasing.md (100%) delete mode 100644 doc/example/20_terrform_1_0/backend.prod.int.properties delete mode 100644 doc/example/20_terrform_1_0/build.py delete mode 100644 doc/example/20_terrform_1_0/route.tf delete mode 100644 doc/example/50_docker_module/build.py delete mode 100644 doc/example/50_docker_module/image/Dockerfile delete mode 100755 doc/example/50_docker_module/image/resources/install.sh delete mode 100644 doc/example/50_docker_module/test/Dockerfile delete mode 100644 doc/example/50_docker_module/test/serverspec.edn diff --git a/doc/DevopsBuild.md b/doc/DevopsBuild.md index f753a39..fb58899 100644 --- a/doc/DevopsBuild.md +++ b/doc/DevopsBuild.md @@ -26,7 +26,7 @@ classDiagram ## Example Usage - +### build.py ```python from subprocess import run @@ -58,4 +58,10 @@ def initialize(project): def list_build_dir(project): build = get_devops_build(project) run(f"ls -la {build.build_path()}") -``` \ No newline at end of file +``` + +### call the build + +```bash +pyb list_build_dir +``` diff --git a/doc/dev_setup.md b/doc/dev/dev_setup.md similarity index 100% rename from doc/dev_setup.md rename to doc/dev/dev_setup.md diff --git a/doc/releasing.md b/doc/dev/releasing.md similarity index 100% rename from doc/releasing.md rename to doc/dev/releasing.md diff --git a/doc/example/20_terrform_1_0/backend.prod.int.properties b/doc/example/20_terrform_1_0/backend.prod.int.properties deleted file mode 100644 index a526630..0000000 --- a/doc/example/20_terrform_1_0/backend.prod.int.properties +++ /dev/null @@ -1,4 +0,0 @@ -bucket = "my-configuration" -key = "my-module" -kms_key_id = "arn:aws:kms:my-kms-alias" -region = "my-region" \ No newline at end of file diff --git a/doc/example/20_terrform_1_0/build.py b/doc/example/20_terrform_1_0/build.py deleted file mode 100644 index bbaa435..0000000 --- a/doc/example/20_terrform_1_0/build.py +++ /dev/null @@ -1,55 +0,0 @@ -from os import environ -from pybuilder.core import task, init -from ddadevops import * - -name = 'my-project' -MODULE = 'my-module' -PROJECT_ROOT_PATH = '../../..' - -class MyBuild(AwsBackendPropertiesMixin, DevopsTerraformBuild): - pass - - -@init -def initialize(project): - project.build_depends_on('ddadevops>=1.0') - stage = environ['STAGE'] - print('Doing stage: ', stage) - config = create_devops_terraform_build_config(stage, - PROJECT_ROOT_PATH, - MODULE, - {}, - use_workspace=False, - terraform_semantic_version="1.0.8") - config = add_aws_backend_properties_mixin_config(config, 'prod') - build = MyBuild(project, config) - build.initialize_build_dir() - - -@task -def plan(project): - build = get_devops_build(project) - build.plan() - - -@task -def tf_apply(project): - build = get_devops_build(project) - build.apply(True) - - -@task -def apply(project): - build = get_devops_build(project) - build.apply(True) - - -@task -def destroy(project): - build = get_devops_build(project) - build.destroy(True) - -@task -def tf_import(project): - build = get_devops_build(project) - build.tf_import('aws_route53_record.v4', 'my-resource-id') \ No newline at end of file diff --git a/doc/example/20_terrform_1_0/route.tf b/doc/example/20_terrform_1_0/route.tf deleted file mode 100644 index 6973b83..0000000 --- a/doc/example/20_terrform_1_0/route.tf +++ /dev/null @@ -1,7 +0,0 @@ -resource "aws_route53_record" "v4" { - zone_id = "my-zone-id-${var.stage}" - name = "test" - type = "A" - ttl = "300" - records = ["8.8.8.8"] -} diff --git a/doc/example/50_docker_module/build.py b/doc/example/50_docker_module/build.py deleted file mode 100644 index 84ede50..0000000 --- a/doc/example/50_docker_module/build.py +++ /dev/null @@ -1,42 +0,0 @@ -from pybuilder.core import task, init -from ddadevops import * - -name = 'example-project' -MODULE = 'docker-module' -PROJECT_ROOT_PATH = '../../..' - -class MyBuild(DevopsImageBuild): - pass - -@init -def initialize(project): - project.build_depends_on('ddadevops>=0.6.0') - stage = 'prod' - dockerhub_user = gopass_field_from_path('your-credential-path', 'login') - dockerhub_password = gopass_password_from_path('your-credential-path') - config = create_devops_docker_build_config( - stage, PROJECT_ROOT_PATH, MODULE, dockerhub_user, dockerhub_password) - build = MyBuild(project, config) - build.initialize_build_dir() - - -@task -def image(project): - build = get_devops_build(project) - build.image() - -@task -def drun(project): - build = get_devops_build(project) - build.drun() - -@task -def publish(project): - build = get_devops_build(project) - build.dockerhub_login() - build.dockerhub_publish() - -@task -def test(project): - build = get_devops_build(project) - build.test() diff --git a/doc/example/50_docker_module/image/Dockerfile b/doc/example/50_docker_module/image/Dockerfile deleted file mode 100644 index 6178011..0000000 --- a/doc/example/50_docker_module/image/Dockerfile +++ /dev/null @@ -1 +0,0 @@ -FROM ubuntu:18.04 diff --git a/doc/example/50_docker_module/image/resources/install.sh b/doc/example/50_docker_module/image/resources/install.sh deleted file mode 100755 index 49d791e..0000000 --- a/doc/example/50_docker_module/image/resources/install.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -function main() { - - upgradeSystem - - # do some stuff - - cleanupDocker -} - -source /tmp/resources/install_functions.sh -main \ No newline at end of file diff --git a/doc/example/50_docker_module/test/Dockerfile b/doc/example/50_docker_module/test/Dockerfile deleted file mode 100644 index 20836e7..0000000 --- a/doc/example/50_docker_module/test/Dockerfile +++ /dev/null @@ -1,7 +0,0 @@ -FROM docker-module -RUN curl -L -o /tmp/serverspec.jar \ - https://github.com/DomainDrivenArchitecture/dda-serverspec-crate/releases/download/1.3.4/dda-serverspec-standalone.jar - -COPY serverspec.edn /tmp/serverspec.edn - -RUN java -jar /tmp/serverspec.jar /tmp/serverspec.edn -v diff --git a/doc/example/50_docker_module/test/serverspec.edn b/doc/example/50_docker_module/test/serverspec.edn deleted file mode 100644 index 80ae6d2..0000000 --- a/doc/example/50_docker_module/test/serverspec.edn +++ /dev/null @@ -1 +0,0 @@ -{:file [{:path "/tmp/resources" :exits false}]}