libero-yoko / ahoy

Helm GUI Tool

Ahoy!

An easy-to-use GUI for Kubernetes Helm
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email, project_title, project_description

Built With

• aaa
• bbb
• ccc

Getting Started

To get a local copy up and running follow these simple steps. In order to Ahoy to be running on your local machine, have Dockers, Kubernetes, Helm setup and runnning.

Prerequisites

Installing Dockers

Install Docker desktop following the instruction below.

https://docs.docker.com/engine/install/

Installing Kubernetes

Installing Helm

Setup Test Environment

Install Minikube

brew install minikube

Start Minikube

minikube start

Attache the node port to minikube node

kubectl create deployment my-minikube --image=k8s.gcr.io/echoserver:1.4
kubectl expose deployment my-minikube --type=LoadBalancer --port=8080

Store the Helm Charts under /user/Library/Application Support/ahoy/charts https://drive.google.com/file/d/1W3EGr3QSlkgQ_SLinfROzFdrh6jhRwg-/view?usp=sharing

Helm install with the chart WordPress4

helm install <your-service-name>  <helm-chart-dir-name>

Kubectl get svc => confirm it’s installed

minikube tunnel 

Minikube dashboard => check if it’s there or not To test history…do a couple of times

helm upgrade <your-service-name>  <helm-chart-dir-name>

To check it made a history

helm history <your-service-name> 

To rollback

helm rollback  <your-service-name> <revision-num>

Mac terminal:

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

helm version

version.BuildInfo{Version:"v3.5.4", GitCommit:"1b5edb69df3d3a08df77c9902dc17af864ff05d1", GitTreeState:"clean", GoVersion:"go1.15.11"}

Installation

1. Clone the repo

   git clone https://github.com/oslabs-beta/Ahoy.git

2. Install NPM packages

   npm install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Joe Bigelow - LinkedIn - GitHub

Tobey Forsman - LinkedIn - GitHub

Yoko Kawamoto - LinkedIn - GitHub

Jin Oh - LinkedIn - GitHub

Project Link: https://github.com/oslabs-beta/Ahoy

Acknowledgements