From 964fdfc5b16b0b931d9e7edbad3e55fb98b08a00 Mon Sep 17 00:00:00 2001 From: Gudmundur Gudmundsson Date: Mon, 6 Nov 2023 21:35:46 +0000 Subject: [PATCH 1/3] Initial readme cleanup --- README.md | 92 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index 73947e7..460f2a5 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,5 @@ # operator +A Docker image for use in cicd pipelines. +Contains useful tools for deployment and provisioning. - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.com/gxmmx/gitops/operator.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.com/gxmmx/gitops/operator/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. -- GitLab From 2fbf19ee8b14cd5f06579a736898584419fb8bac Mon Sep 17 00:00:00 2001 From: Gudmundur Gudmundsson Date: Mon, 6 Nov 2023 23:51:42 +0000 Subject: [PATCH 2/3] Initial operator build --- .gitlab-ci.yml | 23 +++++++++ .hadolint.yaml | 6 +++ CHANGELOG.md | 13 +++++ Dockerfile | 37 ++++++++++++++ README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++- 5 files changed, 214 insertions(+), 1 deletion(-) create mode 100644 .gitlab-ci.yml create mode 100644 .hadolint.yaml create mode 100644 CHANGELOG.md create mode 100644 Dockerfile diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..5b4ec88 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,23 @@ +--- +include: + - remote: "https://gitlab.com/gxmmx/gitops/flow/-/raw/main/templates/lint.gitlab-ci.yml" + - remote: "https://gitlab.com/gxmmx/gitops/flow/-/raw/main/templates/cbuild.gitlab-ci.yml" + +variables: + CIFLOW_LINT_BRANCH_DEV: "false" + CIFLOW_LINT_BRANCH_TEST: "true" + CIFLOW_LINT_BRANCH_MAIN: "true" + + CIFLOW_LINT_DOCKERFILE: "true" + CIFLOW_LINT_DOCKERFILE_REPORT: "false" + CIFLOW_LINT_DOCKERFILE_PATH: "image/Dockerfile" + CIFLOW_LINT_DOCKERFILE_CONFIG: ".hadolint.yml" + + CIFLOW_CBUILD_MULTIARCH: "true" + CIFLOW_CBUILD_ARCH: "linux/arm64,linux/arm64/v8,linux/amd64" + + CIFLOW_CBUILD_DOCKERFILE_PATH: "image/Dockerfile" + CIFLOW_CBUILD_RELEASE_REGISTRY: "docker.io" + CIFLOW_CBUILD_RELEASE_REGISTRY_LINK: "https://hub.docker.com/r" + CIFLOW_CBUILD_RELEASE_USER: "gxmmx" + CIFLOW_CBUILD_RELEASE_IMAGE: "gitops-operator" diff --git a/.hadolint.yaml b/.hadolint.yaml new file mode 100644 index 0000000..efb8953 --- /dev/null +++ b/.hadolint.yaml @@ -0,0 +1,6 @@ +ignored: + - DL3006 + - DL3007 + - DL3018 + - DL3059 + - DL3013 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e3dc16f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + +## [0.1.0] - 2023-11-07 + +### Added + +- Initial Operator container build diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..0e6bc94 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,37 @@ +FROM alpine:latest + +## Versions +ENV TERRAFORM_VERSION 1.6.2 +ENV ANSIBLE_VERSION 2.15.5 +ENV RUAMEL_YAML 0.17.21 + +## Arguments +ARG TARGETARCH + +## Install base +RUN apk add --no-cache wget ca-certificates unzip python3 py3-pip openssl bash && \ + apk add --no-cache --virtual build-dependencies python3-dev libffi-dev openssl-dev build-base +## Install gitlab deps +RUN apk add --no-cache curl gcompat git idn2-utils jq openssh +## Install Ansible deps +RUN pip install --no-cache-dir pip cffi ruamel-yaml==${RUAMEL_YAML} + +## Install Ansible +RUN pip install --no-cache-dir ansible-core==${ANSIBLE_VERSION} + +## Install Cloudflare +RUN pip install --no-cache-dir cloudflare + +## Install Terraform +RUN wget -q -O /terraform.zip "https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_${TARGETARCH}.zip" && \ + unzip /terraform.zip -d /bin + +## Install Gitlab Terraform +RUN wget -q -O /usr/bin/gitlab-terraform "https://gitlab.com/api/v4/projects/18943607/repository/files/src%2Fbin%2Fgitlab-terraform.sh/raw?ref=master" && \ + chmod +x /usr/bin/gitlab-terraform + +## Cleanup +RUN apk del build-dependencies && \ + rm -rf /terraform.zip + +ENTRYPOINT [] diff --git a/README.md b/README.md index 460f2a5..7c0c1ea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,139 @@ # operator -A Docker image for use in cicd pipelines. +A [Docker image](https://hub.docker.com/r/gxxmx/gitops-operator) published on Dockerhub for use in CI-CD pipelines. Contains useful tools for deployment and provisioning. +
+ + +
+

Table of Contents

 + +* [About](#about) +* [Information](#information) +* [Usage](#usage) +* [Changes](#changes) +* [Contributing](#contributing) +* [License](#license) +* [Contact](#contact) + +
+ +
+ + +## About + +Container image mainly for use in CICD pipelines. +Contains [Terraform](https://www.terraform.io), [Gitlab-Terraform](https://docs.gitlab.com/ee/user/infrastructure/iac/gitlab_terraform_helpers.html), [Ansible](https://www.ansible.com) and [Cloudflare cli4](https://github.com/cloudflare/python-cloudflare) + + +## Information + +### Platforms +This container is made for [Gitlab-CI/CD](https://docs.gitlab.com/ee/ci/) pipelines, but is it built on multiple architectures, and can be used on platforms listed on the [Dockerhub repository](https://hub.docker.com/r/gxxmx/gitops-operator). + +
+ + +## Usage + +### Standalone Docker image +The image can be used with Docker directly: + +```sh +docker run --rm -it gxmmx/gitops-operator:latest sh +``` + +This runs a container with the formentioned tooling. + +### Gitlab CI + +Example `.gitlab-ci.yml` for running terraform with a Gitlab managed state. +After deployment Ansible provisions the new infrastructure from the same image. + +``` yaml +--- +image: + name: "gxmmx/gitops-operator:latest" + +variables: + TF_ROOT: ${CI_PROJECT_DIR} + TF_STATE_NAME: statebackendname + +cache: + key: "${TF_ROOT}" + paths: + - ${TF_ROOT}/.terraform/ + +terraform fmt: + stage: validate + script: + - gitlab-terraform fmt + - gitlab-terraform validate + +terraform deploy: + stage: deploy + script: + - gitlab-terraform apply + resource_group: ${TF_STATE_NAME} + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $TF_AUTO_DEPLOY == "true" + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + when: manual + +terraform destroy: + stage: cleanup + script: + - gitlab-terraform destroy + resource_group: ${TF_STATE_NAME} + when: manual + +ansible provision: + stage: provision + script: + - ansible-playbook site.yml + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + when: manual + +``` + +> This example is based on [Gitlabs Terraform Base](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Terraform/Base.gitlab-ci.yml). + + +
+ + +## Changes + +Version history with features and bugfixes, as well as upcoming features and roadmap +depicted in `CHANGELOG.md`. + +
+ + +## Contributing + +Any contributions are greatly appreciated. See `CONTRIBUTING.md` for more information. + +### Contributors + +* [gummigudm](https://gitlab.com/gummigudm) + +
+ + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + +
+ + +## Contact + +Guðmundur Guðmundsson - + +* Gitlab - [gummigudm]() +* Github - [gummigudm]() -- GitLab From c1ca80f655697b9c77b847287044da2430267474 Mon Sep 17 00:00:00 2001 From: Gudmundur Gudmundsson Date: Mon, 6 Nov 2023 23:55:46 +0000 Subject: [PATCH 3/3] Fixing Dockerfile path reference --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5b4ec88..c215211 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -10,13 +10,13 @@ variables: CIFLOW_LINT_DOCKERFILE: "true" CIFLOW_LINT_DOCKERFILE_REPORT: "false" - CIFLOW_LINT_DOCKERFILE_PATH: "image/Dockerfile" + CIFLOW_LINT_DOCKERFILE_PATH: "Dockerfile" CIFLOW_LINT_DOCKERFILE_CONFIG: ".hadolint.yml" CIFLOW_CBUILD_MULTIARCH: "true" CIFLOW_CBUILD_ARCH: "linux/arm64,linux/arm64/v8,linux/amd64" - CIFLOW_CBUILD_DOCKERFILE_PATH: "image/Dockerfile" + CIFLOW_CBUILD_DOCKERFILE_PATH: "Dockerfile" CIFLOW_CBUILD_RELEASE_REGISTRY: "docker.io" CIFLOW_CBUILD_RELEASE_REGISTRY_LINK: "https://hub.docker.com/r" CIFLOW_CBUILD_RELEASE_USER: "gxmmx" -- GitLab