https://github.com/ksingh7/microshift-plus
MicroShift Powered ⚡️ Instant/Local (Just Enough) OpenShift Environment for Developers
https://github.com/ksingh7/microshift-plus
kubernetes microshift openshift
Last synced: 24 days ago
JSON representation
MicroShift Powered ⚡️ Instant/Local (Just Enough) OpenShift Environment for Developers
- Host: GitHub
- URL: https://github.com/ksingh7/microshift-plus
- Owner: ksingh7
- Created: 2022-04-08T21:19:03.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-05T22:54:22.000Z (over 1 year ago)
- Last Synced: 2025-04-04T17:47:51.593Z (about 2 months ago)
- Topics: kubernetes, microshift, openshift
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 12
- Watchers: 2
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
[Microshift](https://github.com/redhat-et/microshift) is a small form factor OpenShift/Kubernetes optimized for edge computing.
[Microshift-Plus](https://github.com/ksingh7/microshift-plus) uses MicroShift at its core but on top it provides tools which are important to deliver instant/local/minuscule OpenShift Environments for Development.
This is a prototype and comes with a set of helper script to setup & purge Microshift-Plus environments runing on Podman for dev/test/homelab setup.
## Features
[Microshift-Plus](https://github.com/ksingh7/microshift-plus) provides the following features
- Initialize & Start Podman Machine (for MacOS)
- Set `rootful` mode needed for Microshift's Privileged container
- Launch Microshift Container
- Check and wait for Microshift to become Ready
- Patch OpenShift Router to use `nip.io` for outbound routing
- Setup OpenShift Web/Developer Console for Microshift
- Get the URL of OpenShift Web Console for easy access
- Setup OpenShift Operator Lifecycle Manager (OLM) (For Operator Catalog)
- Scale down OLM packageserver replica to 1 (optimiaztion, default is 2)
## Usage
- Install [Podman](https://podman.io/getting-started/installation)
- Get the code
```
git clone https://github.com/ksingh7/microshift-plus
cd microshift-plus
```
- Lanuch Microshift environment (MacOS) [sample output](https://github.com/ksingh7/microshift-plus#sample-output)
```
./macos_create_microshift.sh
```
- Deploy a Sample App on Microshift
```
podman exec microshift oc create -f https://raw.githubusercontent.com/ksingh7/microshift-plus/main/02_sample_app.yaml
podman exec microshift oc get route
```
- Purge Microshift environment (MacOS)
```
./macos_purge_microshift.sh
```
## Sample Output
```
Creating Podman Machine...
Starting Podman Machine...
Setting rootful mode...
Launching Microshift...
Waiting for Microshift to become Ready...
Microshift is Now Ready ...
Patch OpenShift Router to use nip.io for outbound routing ...
Setting up OpenShift Web Console ...
----------------------------------------------------------
serviceaccount/openshift-console created
secret/openshift-console-secret created
clusterrolebinding.rbac.authorization.k8s.io/openshift-console-cluster-role-binding created
service/kube-api created
deployment.apps/openshift-console-deployment created
service/openshift-console-service created
route.route.openshift.io/openshift-console created
pod/openshift-console-deployment-7c8785cc5c-46v7q condition met
----------------------------------------------------------
############### OpenShift Console is Ready ###############################
http://openshift-console-kube-system.apps.127.0.0.1.nip.io
##########################################################################
Setting up OLM ...
OLM Setup Completed ...
############### Microshift Setup Completed ###############################
OpenShift Console URL : http://openshift-console-kube-system.apps.127.0.0.1.nip.io
OpenShift / Kubectl Access : podman exec -it microshift /bin/bash
##########################################################################
```
> Note : At my homelab it takes about 5 Minutes to complete, your milage may vary