Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ContainerCraft/Kargo
ContainerCraft Kubevirt PaaS Undercloud
https://github.com/ContainerCraft/Kargo
Last synced: 3 months ago
JSON representation
ContainerCraft Kubevirt PaaS Undercloud
- Host: GitHub
- URL: https://github.com/ContainerCraft/Kargo
- Owner: ContainerCraft
- License: gpl-3.0
- Created: 2024-01-21T17:23:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-15T22:48:19.000Z (9 months ago)
- Last Synced: 2024-05-20T12:11:01.715Z (9 months ago)
- Language: Python
- Homepage:
- Size: 39.8 MB
- Stars: 52
- Watchers: 0
- Forks: 5
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kargo - The Cloud-Native ESXi Replacement
[](https://github.com/ContainerCraft/Kargo/actions/workflows/readme.yaml)
## Overview
Kargo replaces traditional hypervisors with a cloud-native container and virtualization platform. Kargo works seamlessly in on-prem, cloud, and local environments, leveraging Kubernetes to create a robust and scalable platform for modern compute and platform as a service use cases.
Join Kargo users and contributors in the [ContainerCraft Community Discord](https://discord.gg/Jb5jgDCksX)!
> **Note:** Kargo is in early development. Checkout [@usrbinkat](https://twitter.com/usrbinkat)'s [inaugural Twitter/X Thread](https://x.com/usrbinkat/status/1749186949590794551) to see how it all started.
## Project Goals
- Simplify Kubernetes skills development
- Accelerate project ideation and innovation
- Build a shared platform for community collaboration
- Develop an enterprise-grade hyperconverged compute platform
- Foster community equity through a reliable and inclusive platform
- Bring the power of cloud native to homelabs and students
## Getting Started
Try Kargo with just a browser to get started with [GitHub Codespaces](https://github.com/features/codespaces) following the steps below.
### Prerequisites
Ensure you have the following tools and accounts:
1. [GitHub](https://github.com)
2. [Pulumi Cloud](https://app.pulumi.com/signup)
3. [Microsoft Edge](https://www.microsoft.com/en-us/edge) or [Google Chrome](https://www.google.com/chrome)
### Quickstart
Check out the video to see Kargo deploy for yourself, or try it in your browser with the steps below.
#### Step-by-Step Instructions
1. **Log in to GitHub.**
2. **Launch Kargo in GitHub Codespaces:**
- Use the [Launch Kargo](https://bit.ly/launch-kargo-kubevirt-paas-in-github-codespaces) link directly or use the green `Code` button above to start a new Codespace.
- Create a new Codespace with the following options:
- **Branch:** `main`
- **Dev Container Configuration:** `konductor`
- **Region:** Your choice
- **Machine Type:** 4 cores, 16 GB RAM, or better
3. **Open the VSCode Integrated Terminal:**
- Use key combination `[ Ctrl + ` ]` to open the terminal.
4. **Authenticate Credentials**
Login to Pulumi Cloud and other services.
```bash {"id":"01J5VC1KTJBR22WEDNSSGTNAX4","name":"login"}
task login
```
5. **Configure:**
Configure the Pulumi IaC Stack parameters.
```bash {"id":"01J5VC1KTJBR22WEDNSWYBKNQS","name":"configure"}
# confirm Pulumi stack
export ORGANIZATION="${GITHUB_USER:-${GITHUB_REPOSITORY_OWNER:-}}"
export DEPLOYMENT="${RepositoryName:-}"
task configure
```
6. **Deploy Kubernetes:**
Deploy Kubernetes using Talos.
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNSX4RHEG2","name":"kubernetes"}
task kubernetes
```
7. **Deploy Platform:**
Deploy the Kubevirt PaaS IaC to Kubernetes.
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNSZW7QADA","name":"deploy"}
task deploy
```
8. **Deploy a Virtual Machine:**
Deploy an Ubuntu Virtual Machine on the platform using Kubevirt.
> **Note:** Run this step manually via integrated terminal.
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT2EWEW9Q","name":"vm"}
# Purge old known host fingerprints
task ssh-clean
# Enable the VM instance
pulumi config set --path vm.enabled true
# Deploy the Kubevirt VM instance
pulumi up --skip-preview --refresh=false
```
9. **SSH to the new VM Instance:**
Access the VM via SSH using a Kubernetes NodePort service.
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT3YSQGM0","name":"ssh"}
ssh -p 30590 -i ~/.ssh/id_rsa -o StrictHostKeyChecking=no kc2@localhost screenfetch
```
10. **Virtctl SSH:**
Use `virtctl` to access the VM via SSH without a NodePort service.
```bash {"background":"true","excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT6VNC5EK","name":"virtctl-ssh"}
# SSH using virtctl
virtctl ssh kc2@ubuntu
```
11. **Virtctl Serial Console:**
Use `virtctl` to access the serial console of the VM.
```bash {"background":"true","excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT7BDRMAV","name":"virtctl-console"}
# Serial console access
virtctl console ubuntu
```
> **Tip:** To exit the serial console, press `Ctrl + ]` or close the terminal.
12. **Cleanup:**
Clean up all Kubernetes and Pulumi resources.
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT7BDRMAV","name":"clean"}
task clean-all
```
## Contributing
Kargo thrives on community contributions. Learn how to get involved by reading our [CONTRIBUTING.md](https://github.com/ContainerCraft/Kargo/issues/22).
### Developing Kargo
Use our GitHub Actions integration and the `act` tool to test CI pipelines locally before pushing your changes.
To test Kargo CI locally:
```bash {"excludeFromRunAll":"true","id":"01J5VC1KTJBR22WEDNT92WYZEH"}
task act
```
## Join the Community + Learn More
For more discussion, support, and contribution, join our [ContainerCraft Community Discord Kargo Channel](https://discord.gg/Jb5jgDCksX).
For more information, explore the [Kargo Project FAQ](FAQ.md).