An open API service indexing awesome lists of open source software.

https://github.com/ironcore-dev/metal-load-balancer-controller

Service IP announcement controller using the metalbond route reflector
https://github.com/ironcore-dev/metal-load-balancer-controller

kubernetes loadbalancer

Last synced: 8 months ago
JSON representation

Service IP announcement controller using the metalbond route reflector

Awesome Lists containing this project

README

          

# metal-load-balancer-controller

[![REUSE status](https://api.reuse.software/badge/github.com/ironcore-dev/metal-load-balancer-controller)](https://api.reuse.software/info/github.com/ironcore-dev/metal-load-balancer-controller)
[![Go Report Card](https://goreportcard.com/badge/github.com/ironcore-dev/metal-load-balancer-controller)](https://goreportcard.com/report/github.com/ironcore-dev/metal-load-balancer-controller)
[![GitHub License](https://img.shields.io/static/v1?label=License&message=Apache-2.0&color=blue)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)

`metal-load-balancer-controller` is a Kubernetes operator for announcing `Service` IPs for `LoadBalancer` type `Services`
in a bare metal Kubernetes cluster by leveraging routing services provided by the [metalbond](https://github.com/ironcore-dev/metalbond)
project.

## 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`:**

```sh
make docker-build docker-push IMG=/metal-load-balancer-controller: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.

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

```sh
make deploy IMG=/metal-load-balancer-controller: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:

```sh
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:**

```sh
kubectl delete -k config/samples/
```

**Delete the APIs(CRDs) from the cluster:**

```sh
make uninstall
```

**UnDeploy the controller from the cluster:**

```sh
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:

```sh
make build-installer IMG=/metal-load-balancer-controller: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.

2. Using the installer

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

```sh
kubectl apply -f https://raw.githubusercontent.com//metal-load-balancer-controller//dist/install.yaml
```

## Contributing

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

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## Licensing

Copyright 2025 SAP SE or an SAP affiliate company and IronCore contributors. Please see our [LICENSE](LICENSE) for
copyright and license information. Detailed information including third-party components and their licensing/copyright
information is available [via the REUSE tool](https://api.reuse.software/info/github.com/ironcore-dev/metal-load-balancer-controller).