Skip to content

Commit e1441d0

Browse files
Updated Readme with ergonomic changes (#170)
The following ergonomic changes were made to the readme file : 1. The Operation Code website was linked in the reference. 2. The SETUP.md file content was added aptly to the readme, it was creating an unnecessary redirect and having the same content in the readme makes it easier for users 3. Added a backlink to ArgoCD 4. Added a backlink to AWS services referred 5. Added the Licensing reference to the readme alongside the MIT License badge like most official repositories Hence, also closes #167 #168 #169 Looks good
1 parent b59b119 commit e1441d0

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,28 @@
1616
<br />
1717

1818
# Operation Code Infra
19-
Platform infrastructure for the Operation Code site.
19+
Platform infrastructure for the [Operation Code site](https://operationcode.org/).
2020

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

2323
## warning
2424

25-
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.
25+
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.
2626

27-
To set up your workstation to access our Kubernetes cluster, please see [SETUP.md](SETUP.md)
27+
To set up your workstation to access our Kubernetes cluster, please check the below instructions
28+
29+
## Setup
30+
31+
### Operation Code's Kubernetes Cluster.
32+
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!
33+
34+
### Getting access to the cluster
35+
1. Ensure you have [AWS](https://aws.amazon.com) access, and the [aws CLI](https://aws.amazon.com/cli/) is operating correctly
36+
2. Install eksctl: https://eksctl.io/introduction/#installation
37+
3. Run: `eksctl utils write-kubeconfig --region us-east-2 --cluster operationcode-backend`
38+
4. Verify everything works: `kubectl get namespaces`
39+
40+
41+
## Licensing
42+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
43+
Operation Code Infra is under the [MIT License](/LICENSE).

0 commit comments

Comments
 (0)