Ahoy!

An easy-to-use GUI for Helm

Ahoy! is a GUI tool for DevOps engineers which distills the many functions of Helm into a user-friendly interface. A GUI visually aids all engineers (even those that love CLI) and better organizes the various configuration files. The ability to quickly revert to a previous version will give the DevOps engineer peace of mind.

Built With

React, Electron, Semantic UI

Getting Started

Ahoy! requires a local Kubernetes cluster. To get one up and running, follow the steps below.

Prerequisites

You'll want these things installed and running.

Helm
MiniKube
Docker
Helm Charts. Bring your own or download from https://artifacthub.io.

Installation

Download the latest release or clone the repo and build your own.

Clone the repo

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

Install dependancies
```
npm install
```

Build

npm run package
# then...
npm run package-mac
npm run package-windows
npm run package-linux

Usage

Setup Environment

Launch the Docker Daemon
Start a MiniKube Kubernetes Cluster minikube start
Download charts (see below for location)
Launch Ahoy!

Local Helm Chart Storage Paths

macOS: /Users/<username>/Library/Application\ Support/ahoy/charts
Windows: C:\Users\<username>\AppData\Roaming\Ahoy\charts

Tip:

Attach the node port to minikube node so you can see your cluster(s) in the browser.

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

To launch the application in developer mode:

npm start

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.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request to the Staging branch

License

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

Contributors

Joe Bigelow - LinkedIn - GitHub

Tobey Forsman - LinkedIn - GitHub

Yoko Kawamoto - LinkedIn - GitHub

Jin Oh - LinkedIn - GitHub

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

oslabs-beta/Ahoy

oslabs-beta

Reviews

Repository Details