oslabs-beta / ahoy

Ahoy! is a GUI tool for DevOps engineers which distills the many functions of Helm into a user-friendly interface.

Ahoy!

Website | Github | Bugs/Features

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.

1. Clone the repo

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

2. Install dependancies

   npm install

3. Build

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

Usage

Setup Environment

1. Launch the Docker Daemon
2. Start a MiniKube Kubernetes Cluster minikube start
3. Download charts (see below for location)
4. 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.

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 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

Acknowledgements

• OS Labs
• Matthew Marchand
• horseQL

ahoy's Issues

Check Helm version upon startup and display on front end

Installed chart details do not update after rollback function is completed

Chart Upgrade button

Incorporate a button that allows you to upgrade a current Helm release by specifying the chart to upgrade it to (e.g. path to directory, chart URL, etc)

Establish a local, persistent data storage

Use STDOUT/STDERR objects from child processes to turn into Electron modals

Most helper functions that deal with the command line result in stdout/stderr objects that are currently unused. The contents of these objects differ depending on the command/function, but of a common format that can be deconstructed into informative modals for better UX.

why do i need a local k8s cluster?

I found this because we do a lot of helming in a few remote k8s clusters.

Why do i need a local minikube again? my notebook cannot cope!

Or is there a way to reconfigure this and the readme is lacking a remark in this direction?

cheers

View changes between history instances of Helm chart release

Either hover over or click that opens up a pop up, showing all the changes made between chart releases. Code editor formatting (thinking VS Code) and changes highlighted in red and green.

Edit a chart in the app

• consider using https://microsoft.github.io/monaco-editor/

Format date and time of chart installation using Moment.js

Search for and download charts from Artifact Hub

Leverage Artifact Hub API to add this functionality directly into front end of the app

UI to input all the values?

Would it be possible to have a UI form with all the possible values of values.yaml?

Check if a Kubernetes environment is running and display status

Remove Mac OS X specific files from Release.

The "Ahoy-win32-ia32" Zip File contains a "_MACOSX" Folder and the "Ahoy-win32-ia32" folder itself contains the typical OS X ".DS_Store" File. Since both are not needed, they should removed from the release.

Add chart version to each local chart

FileSystemHelper.js method to extract chart version from Chart.yaml

Incorporate Dark Mode