In modern software development practices, the use of Architecture Decision Records (ADRs) has become increasingly +common. ADRs are documents that capture important architectural decisions made during the development process. These +decisions play a crucial role in guiding the development team and ensuring consistency and coherence in the architecture +of the software system.
+We will utilize ADRs in our team to document and communicate architectural decisions effectively. Furthermore, we +will publish these ADRs publicly to promote transparency and facilitate collaboration.
+Use the template below to add an ADR:
+---
+ title: 0004 Title
+ adr:
+ author: Jean-Loup Monnier
+ created: 01-Aug-2023
+ status: draft | proposed | rejected | accepted | superseded
+ superseded_by: 0001-test
+ extends:
+ - 0001-first
+ - 0002-second
+---
+
+## Context
+
+What is the issue that we're seeing that is motivating this decision or change?
+
+## Assumptions
+
+Anything that could cause problems if untrue now or later. (optional)
+
+## Decision
+
+What is the change that we're proposing and/or doing?
+
+## Risks
+
+Anything that could cause malfunction, delay, or other negative impacts. (optional)
+
+## Consequences
+
+What becomes easier or more difficult to do because of this change?
+
+## More Information
+
+Provide additional evidence/confidence for the decision outcome
+Links to other decisions and resources might here appear as well. (optional)
+In the landscape of software development, the choice of coding platform significantly impacts developer productivity, +collaboration, and code quality. it's crucial to evaluate and select a coding platform that aligns with our development +needs and fosters efficient workflows.
+The following assumptions are made:
+After careful consideration and evaluation of various options like GitHub, GitLab and BitBucket, we propose adopting +GitHub as our primary coding platform. The decision is based on the following factors:
+Costs: There are currently no costs associate in using GitHub for our usecases.
+Features and Functionality: GitHub offers a comprehensive set of features essential for modern software development +and collaboration with external teams, including version control, code review, issue tracking, continuous integration, +and deployment automation.
+Security: GitHub offers a complete set of security features essential to secure development like dependency management +and security scanning.
+Community and Ecosystem: GitHub boasts a vibrant community and ecosystem, facilitating knowledge sharing, collaboration, +and access to third-party tools, and services that can enhance our development workflows. Within our organization we have +easy access to the team managing the GitHub organization.
+Usability and User Experience: A user-friendly interface and intuitive workflows are essential for maximizing developer +productivity and minimizing onboarding time. GitHub offers a streamlined user experience and customizable workflows that +align with our team's preferences and practices.
+Currently the organization of MinBZK on GitHub does not have a lot of people indicating that our team is an early
+adapter of the platform within the organization. This might impact our features due to cost constrains.
If we choose another tool in the future we need to migrate our codebase, and potentially need to rewrite some specific GitHub +features that cannot be used in another tool.
+Alternatives considered:
+Our development team wants to implement a CI/CD solution to streamline the build, +testing, and deployment workflows of our software products. Currently, our codebase resides on GitHub, and we leverage +Kubernetes as our chosen orchestration platform, managed by the DigiLab platform team.
+We will use the following tools for CI/CD pipeline:
+GitHub Actions aligns with our existing infrastructure, ensuring seamless integration with our codebase and minimizing +operational overhead. GitHub Actions' specific syntax for CI results in vendor lock-in, necessitating significant effort +to migrate to an alternative CI system in the future.
+Flux, being a GitOps operator for Kubernetes, offers a declarative approach to managing deployments, enhancing +reliability and repeatabilty within our Kubernetes ecosystem.
+ + + + + + + + + + + + + + + + + + + + + + + + +Our team recognizes the necessity of a platform to run our software, as our local machines lack the capacity to handle +certain workloads effectively. We have evaluated several options available to us:
+We operate under the following assumptions:
+We will use Digilab Kubernetes for our workloads.
+By choosing Digilab Kubernetes, we gain access to a namespace within their managed Kubernetes cluster. However, it's +important to note that Digilab does not provide any guarantees regarding the availability of the cluster. Should our +software require higher availability assurances, we may need to explore alternative solutions.
+ + + + + + + + + + + + + + + + + + + + + + + + +Make sure you have installed Mattermost, then follow these steps.
+Make sure you have installed Webex, then follow these steps.
+Create or use your existing Github account.
+Bookmark these links in your browser:
+ + + + + + + + + + + + + + + + + + + + + + + + + +We are assuming your dev machine is a mac.
+brew install --cask rectangle
+brew install --cask webex
+brew install --cask mattermost
+brew install --cask iterm2
+git clone https://github.com/zsh-users/zsh-autosuggestions ~/.oh-my-zsh/custom/plugins/zsh-autosuggestions
+Add plugins to your shell in ~/.zshrc
plugins = (... kubectl pyenv z)
+brew install --cask sourcetree
+brew install pyenv
+xcode-select --install
+