One-Click OSS Deployment Platform

Introduction

Welcome to the One-Click Deployment Platform. This project aims to provide a user-friendly interface for deploying dockerized containers on a Kubernetes cluster.
It's built with the following technologies:

• Frontend: Sveltekit
• Backend: Go & Pocketbase
• Operator: Operator SDK -> one-click-operator

Features

• Simplified Deployment: Deploy your favorite dockerized container with a single click.
• Kubernetes Integration: Utilizes Kubernetes for efficient container orchestration.
• User-Friendly Interface: Intuitive UI for users without a technical background.
• Customizable: Customize your deployment with a variety of options.
• Blueprints: Create and share your own deployment blueprints.

Getting Started

Prerequisites

You will need the following to run this project:

• Kubernetes cluster
• Docker daemon
• Node.js v18.16.0 or higher
• npm v9.5.1 or higher
• Go
• Kubectl
• Kustomize

Installation

1. Install the Operator Follow the installation instructions provided in the one-click-operator repository.

2. Install the UI & Backend Check out the deployment folder and change the values for your environment. Then run the following commands:

   cd deployment
   kubectl apply -k .
   

3. Access the UI

   # if you are using an ingress
   kubectl get ingress -n one-click
   # if you want to use port-forwarding
   kubectl port-forward -n one-click svc/one-click-ui 8080:80
   

4. Access Pocketbase on your URL or localhost:8080 with /_ as the path. Example: localhost:8080/_. You should see the Pocketbase UI and set your admin user. Then create a new user under users collection. You can now login with your new user.

Usage

Blueprints

Blueprints are an abstraction of a deployment. They contain some predefined values and can be used to deploy a certain container with a single click. You can create your own blueprints and share them with others.

Check out the blueprints folder for examples.

Projects

You can create projects which their id's will be the name of the namespace inside the Kubernetes cluster. You can tag these projects to make it more easy to filter (e.g. by environment).

Deployments

Deployments are based on blueprints. You must create a deployment from a blueprint and customize it to your needs. Each configuration is stored in a rollout. A rollout is a version of a deployment configuration (like a snapshot). So each time you change a configuration, a new rollout is created. You can then rollback to a previous rollout. Deployments within the same project will get created in the same namespace. So keep in mind to not use the same ingress hosts.

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. Submit your PR

Custom CA Certificates

If you need to connect to services with custom/self-signed SSL certificates (like private S3 storage for Pocketbase backups), you can add your CA certificates in two ways:

1. Using Environment Variable:

   # Add your CA certificate through environment variable
   docker run -e CUSTOM_CA_CERT="$(cat your-ca-cert.pem)" -p 8090:8090 one-click
   

   For Kubernetes deployment, add this to your deployment manifest:

   spec:
     template:
       spec:
         containers:
         - name: one-click
           env:
           - name: CUSTOM_CA_CERT
             valueFrom:
               secretKeyRef:
                 name: ca-cert-secret
                 key: ca.crt
   

2. Using Volume Mount:

   # Mount your certificates directory
   docker run -v /path/to/your/certs:/usr/local/share/ca-certificates:ro -p 8090:8090 one-click
   

   For Kubernetes deployment, use a volume mount:

   spec:
     template:
       spec:
         volumes:
         - name: ca-certs
           secret:
             secretName: ca-cert-secret
         containers:
         - name: one-click
           volumeMounts:
           - name: ca-certs
             mountPath: /usr/local/share/ca-certificates
             readOnly: true
   

This is particularly useful when setting up Pocketbase backups to an S3 storage with self-signed or private CA certificates. The certificates will be automatically added to the system's certificate store when the container starts.