Skip to content

Updated Readme with ergonomic changes #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
projectLewis merged 1 commit into from
Oct 3, 2020
Merged

Updated Readme with ergonomic changes #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,28 @@
<br />

# Operation Code Infra
Platform infrastructure for the Operation Code site.
Platform infrastructure for the [Operation Code site](https://operationcode.org/).

[![CircleCI](https://circleci.com/gh/OperationCode/operationcode_infra/tree/master.svg?style=svg)](https://circleci.com/gh/OperationCode/operationcode_infra/tree/master)

## warning

This repository is using ArgoCD to deploy the Operation Code infrastructure. Changes landed on main in this repository are reflected in the real running infrastructure.
This repository is using [ArgoCD](https://argoproj.github.io/argo-cd/) to deploy the Operation Code infrastructure. Changes landed on main in this repository are reflected in the real running infrastructure.

To set up your workstation to access our Kubernetes cluster, please see [SETUP.md](SETUP.md)
To set up your workstation to access our Kubernetes cluster, please check the below instructions

## Setup

### Operation Code's Kubernetes Cluster.
Greetings! Much of Operation Code's web site runs in a [Kubernetes](https://kubernetes.io/) cluster. These instructions will guide you through setting up access to our cluster so you can run rails console, tail logs, and more!

### Getting access to the cluster
1. Ensure you have [AWS](https://aws.amazon.com) access, and the [aws CLI](https://aws.amazon.com/cli/) is operating correctly
2. Install eksctl: https://eksctl.io/introduction/#installation
3. Run: `eksctl utils write-kubeconfig --region us-east-2 --cluster operationcode-backend`
4. Verify everything works: `kubectl get namespaces`


## Licensing
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Operation Code Infra is under the [MIT License](/LICENSE).