Heimdall
A small microservice to allow external services to obtain an Istio configuration based on some external authentication mechanism, like database or OAuth, etc.
Heimdall is meant to run on Kubernetes.
Currently supported auth methods for clients
- Kubernetes ConfigMap database (ClientID/ClientSecret)
- ...
- TODO
Installation
Install the Helm chart of Heimdall configure it beforehand:
helm install -n heimdall --create-namespace heimdall ./components/heimdall/deploy/charts/heimdall
Take note of the exposed Heimdall service, this can be used in mobile applications for example to get an Istio entry configuration:
kubectl describe services -n heimdall heimdall-gw | grep Ingress | awk '{print $3}'
Populate the client database
The client database holds the list of clients (indexed by ClientID) and their attributes/configuration for the mesh.
A sample entry:
16362813-F46B-41AC-B191-A390DB1F6BDF: |
{
"ClientSecret": "16362813-F46B-41AC-B191-A390DB1F6BDF",
"ClientOS": "ios",
"WorkloadName": "ios-mobile-app",
"PodNamespace": "external",
"Network": "network2",
"MeshID": "mesh1",
"ServiceAccountName": "ios-mobile",
"Service": "ios-mobile"
}
Create the identity service account of the workload
Create the service account in the pod namespace referenced by the client entry above.
kubectl create sa -n external ios-mobile
Heimdall Webhook
Getting Started
You’ll need a Kubernetes cluster to run against.
You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info
shows).
Running on the cluster
- Install Instances of Custom Resources:
kubectl apply -f config/samples/
- Build and push your image to the location specified by
IMG
:
make docker-build docker-push IMG=<some-registry>/heimdall:tag
- Deploy the controller to the cluster with the image specified by
IMG
:
make deploy IMG=<some-registry>/heimdall:tag
Uninstall CRDs
To delete the CRDs from the cluster:
make uninstall
Undeploy controller
UnDeploy the controller to the cluster:
make undeploy
Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project
How it works
This project aims to follow the Kubernetes Operator pattern
It uses Controllers
which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster
Test It Out
- Install the CRDs into the cluster:
make install
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run
NOTE: You can also run this in one step by running: make install run
Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifests
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
License
Copyright 2022.
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.