Skip to content

Visualize historical changes to your ArgoCD cluster

License

Notifications You must be signed in to change notification settings

oslabs-beta/Aionic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aionic Logo

Aionic is a historical registry and rollback tool for your Argo CD managed apps


Before setup

NOTE: Aionic requires you to setup your own MongoDB database and OAuth through your Github account, but Aionic WILL manage your database and OAuth user Github authenication.

These are what you'll need before we begin:

  • MongoDB URI
  • ArgoCD Token
    • An admin ArgoCD token that has access to all apps, so Aionic can update and store all applications and kubernetes manifests in real time
    • A personal ArgoCD token for each user to gain access to specific apps based on their privileges.
  • ArgoCD URL
  • Github Client ID and Secret

For more information on how to setup up MongoDB, click here

For more information on how to setup up an OAuth app on your account, click here or follow the steps below.

How to setup

Pre-Requisite


Clone the repo to your local machine


SET UP YOUR ENVIRONMENT VARIABLES IN Aionic-dev.yml

The Aionic-dev.yml can be found in root directory of repo

  • Get Client_ID/Secret and calback url from Github

    • Go to github setting
    • Click on github Developer setting on the bottom of the list.
    • create new OAuth App

    - callback URL must be forwarded to [https://localhost:3000]/server/auth/callback

    • copy Client_ID and paste it onto Aionic-dev.yml as GITHUB_ID
    • copy newly generated client secret paste it onto GITHUB_SECRET
    • copy callback url from previous step paste it onto GITHUB_CALLBACK_URL
  • post your ArgoCD url and api_key to the enviroment variable "url" and api_key under api image in Aionic-dev.yml
    to access of localhost of host make sure to use host.docker.interal instead of localhost

  • get your mongoDB uri and paste it to the enviroment variable "mongodb_uri" under api image in Aionic-dev.yml


    Make sure that nginx url is same as github callback url. Since the nginx is only point of entry

After you are done with steps above

run these lines of command to build and start your docker-container

  npm run Aionic-build-dev

this command will build Aionic container images

  npm run Aionic-up-dev

this will start Aionic container

To Stop the container ctrl + C

  npm run Aionic-down-dev  

this will completely stop the container


DEMO

Aionic Authentication



Aionic Work flow



Authors

Nathan Lui Jian Cheng Lu Timothy Kwon Ari Bengiyat

How to contribute

Encountering a bug or wanting features that are missing with our app? Please let us know by opening an issue in our Github repository on how we can improve!

If you want to contribute directly, please submit a pull request following the guidelines listed here.

Show us your support!

If you liked our app, please show us your support by giving this repo a big ⭐

License

Aionic is released under the MIT License

About

Visualize historical changes to your ArgoCD cluster

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages