From 9437e87a39e2a674678f2d67b0ef6f252f01c40a Mon Sep 17 00:00:00 2001 From: Matt Perreault Date: Tue, 23 May 2023 20:05:00 -0600 Subject: [PATCH 1/4] Fix Tilt install link - Clean up local cluster list. - Add k9s my favorite tool to interact with k8s clusters. --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 86cc7d3..f620f81 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,23 @@ Before getting started with the development of this app, make sure you have the - [Golang](https://golang.org/doc/install) - [Docker](https://docs.docker.com/get-docker/) - [Kubernetes](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [Tilt](https://tilt.dev/install/) +- [Tilt](https://docs.tilt.dev/install.html) ## Local Kubernetes Cluster If you don't have a local kubernetes cluster set up, you can use the following: -Minikube: A tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a Virtual Machine (VM) on your laptop. -- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) -Docker for Desktop: Includes a standalone Kubernetes server and client, as well as Docker CLI integration. -- [Docker for Desktop](https://www.docker.com/products/docker-desktop) -Kind: A tool for running local Kubernetes clusters using Docker containers as the nodes. -Microk8s: A fast, lightweight, and easy-to-install distribution of Kubernetes that runs natively on Ubuntu. -Kubeadm: A toolkit that helps users bootstrap a best-practice Kubernetes cluster in an easy and repeatable way. + +- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/): A tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a Virtual Machine (VM) on your laptop. + +- [Docker for Desktop](https://docs.docker.com/desktop/get-started/#kubernetes): Includes a standalone Kubernetes server and client, as well as Docker CLI integration. + +- [Kind](https://kind.sigs.k8s.io/): A tool for running local Kubernetes clusters using Docker containers as the nodes. + +- [Microk8s](https://microk8s.io/): A fast, lightweight, and easy-to-install distribution of Kubernetes that runs natively on Ubuntu. + +- [Kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/): A toolkit that helps users bootstrap a best-practice Kubernetes cluster in an easy and repeatable way. + +- [k9s](https://k9scli.io/): A terminal based UI to interact with your Kubernetes clusters. + # Setup Personal Access Token To use the GitHub API, you will need to create a personal access token. You can do this by following the steps below: - Go to your GitHub account settings From a36f02ef456773520cf2acb1fad49b0a87a9d986 Mon Sep 17 00:00:00 2001 From: Matt Perreault Date: Tue, 23 May 2023 21:22:11 -0600 Subject: [PATCH 2/4] Update 1Password doc section. --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f620f81..66fe6d9 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,27 @@ To use the GitHub API, you will need to create a personal access token. You can - Copy the token and save it somewhere safe like a password manager ## Setup Environment Variables with 1password -I reccomend setting up a new vault with 1password for local development items -install 1password cli +I reccomend setting up a new vault with 1password for local development items. + +Install 1password cli +```bash brew install --cask 1password/tap/1password-cli -login to 1password (link to 1password cli) +``` +login to 1password [1password CLI GitHub integration](https://developer.1password.com/docs/cli/shell-plugins/github/#step-1-create-a-github-personal-access-token) + +```bash op signin my.1password.com +``` set up environment variables + +```bash export GITHUB_ACCESS_TOKEN=op://development/github/personal_access_token_dataworkflow +``` start the app with tilt + +```bash op run -- tilt up +``` ## Database This app uses PostgreSQL for data storage. You can either use an existing database, or create a new one using [Docker](https://hub.docker.com/_/postgres). From 718c7affbe0a56e96ab5f55e6283521d9996de9a Mon Sep 17 00:00:00 2001 From: Matt Perreault Date: Tue, 23 May 2023 23:35:29 -0600 Subject: [PATCH 3/4] Update 1password docs. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66fe6d9..74a09b2 100644 --- a/README.md +++ b/README.md @@ -45,10 +45,13 @@ Install 1password cli ```bash brew install --cask 1password/tap/1password-cli ``` +> **_NOTE:_** If on a Linux machine be sure to disable the biometrics unlock with +`$ export $OP_BIOMETRIC_UNLOCK_ENABLED=false` + login to 1password [1password CLI GitHub integration](https://developer.1password.com/docs/cli/shell-plugins/github/#step-1-create-a-github-personal-access-token) ```bash -op signin my.1password.com +op signin ``` set up environment variables From 28798907d32b0da33375ad2489b196eb887df30f Mon Sep 17 00:00:00 2001 From: Matt Perreault Date: Wed, 24 May 2023 00:05:55 -0600 Subject: [PATCH 4/4] Add helm dependency, update GITHUB_ACCESS_TOKEN envar to be more generic. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74a09b2..744e525 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ This app is a combination of Go, Python, and PostgreSQL, and requires the follow Before getting started with the development of this app, make sure you have the following installed on your system: - [Golang](https://golang.org/doc/install) - [Docker](https://docs.docker.com/get-docker/) +- [Helm](https://helm.sh/docs/intro/install/) - [Kubernetes](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - [Tilt](https://docs.tilt.dev/install.html) @@ -53,10 +54,10 @@ login to 1password [1password CLI GitHub integration](https://developer.1passwor ```bash op signin ``` -set up environment variables +set access token via 1password vault path ```bash -export GITHUB_ACCESS_TOKEN=op://development/github/personal_access_token_dataworkflow +export GITHUB_ACCESS_TOKEN=op://// ``` start the app with tilt