mentos1386/mnts-dev-loadbalancer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Custom Kubernetes Loadbalancer implementation
1 commit 1 branch 0 tags 57 KiB
Go 60%
Makefile 34.8%
Dockerfile 5.2%
Find a file
Tine d2d3db7734
feat: initial commit
2024-07-28 20:24:36 +02:00
cmd feat: initial commit 2024-07-28 20:24:36 +02:00
config feat: initial commit 2024-07-28 20:24:36 +02:00
hack feat: initial commit 2024-07-28 20:24:36 +02:00
test feat: initial commit 2024-07-28 20:24:36 +02:00
.dockerignore feat: initial commit 2024-07-28 20:24:36 +02:00
.gitignore feat: initial commit 2024-07-28 20:24:36 +02:00
.golangci.yml feat: initial commit 2024-07-28 20:24:36 +02:00
Dockerfile feat: initial commit 2024-07-28 20:24:36 +02:00
go.mod feat: initial commit 2024-07-28 20:24:36 +02:00
go.sum feat: initial commit 2024-07-28 20:24:36 +02:00
Makefile feat: initial commit 2024-07-28 20:24:36 +02:00
PROJECT feat: initial commit 2024-07-28 20:24:36 +02:00
README.md feat: initial commit 2024-07-28 20:24:36 +02:00

README.md

mnts-dev-loadbalancer

Custom kubernetes loadbalancer implementation for special purpose.

Description

Instead of having Layer2, BGP, cloud provided LB, it insteads manages reverse-proxies/loadbalancers externally to the kubernetes cluster and routes traffic to the ClusterIP.

Requirements:

  • Have some kind of public instance that is running one of the supported reverse-proxies or loadbalancer.
    • Public instance can be cheap VPS or OpenWRT router...
  • The public instance should be able to reach Kubernetes ClusterIP.

Getting Started

Prerequisites

  • go version v1.22.0+
  • docker version 17.03+.
  • kubectl version v1.11.3+.
  • Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/mnts-dev-loadbalancer:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/mnts-dev-loadbalancer:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Project Distribution

Following are the steps to build the installer and distribute this project to users.

  1. Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/mnts-dev-loadbalancer:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

  1. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/mnts-dev-loadbalancer/<tag or branch>/dist/install.yaml

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2024.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.