- Creates the OpenZiti **ocm-hub-api** service used to expose the hub Kubernetes API.
- Reconciles the configured managed-cluster list on Helm upgrades.
- Cleans up OCM and OpenZiti resources during Helm uninstall.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
**Architecture**
## Add your files
The hub chart combines OCM cluster lifecycle management with OpenZiti connectivity.
*[Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
*[Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
```
Helm install ocm-hub
│
▼
OpenZiti bootstrap
|
+--> Create hub-ziti identity
+--> Retrieve enrollment JWT
+--> Enroll identity
+--> Create Kubernetes identity Secret
│
▼
Start ziti-edge-tunnel
│
▼
Create OpenZiti hub API service
|
+--> intercept.v1
+--> host.v1
+--> Bind policy
|
▼
clusteradm init --wait
│
▼
OCM Hub Control Plane
│
▼
Create configured ManagedClusters with hubAcceptsClient=true
Use the built-in continuous integration in GitLab.
openziti:
enabled: true
*[Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
*[Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
*[Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
*[Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
*[Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
controller:
url: "https://<OPENZITI-CONTROLLER>:8441"
username: "<OPENZITI-USERNAME>"
password: "<OPENZITI-PASSWORD>"
***
identity:
name: "hub-ziti"
secretName: "ziti-hub-identity"
# Editing this README
hubApi:
serviceName: "ocm-hub-api"
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
ziti-edge-tunnel:
image:
registry: docker.io
repository: openziti/ziti-edge-tunnel
tag: "1.1.5"
## Suggestions for a good README
secret:
existingSecretName: "ziti-hub-identity"
keyName: persisted-identity
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
tolerations:
- operator: Exists
```
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
#### Configuration Reference
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
| Value | Description |
|---|---|
| `managedClusters` | List of managed clusters that should exist on the OCM hub. The chart creates missing entries and removes entries no longer configured. |
| `openziti.enabled` | Enables the OpenZiti integration and `ziti-edge-tunnel` dependency. |
| `openziti.controller.url` | OpenZiti Controller management API endpoint. |
| `openziti.controller.username` | Username used by bootstrap and configuration Jobs to authenticate to the OpenZiti Controller. |
| `openziti.controller.password` | Password used to authenticate to the OpenZiti Controller. |
| `openziti.identity.name` | OpenZiti identity created for the hub cluster. |
| `openziti.identity.secretName` | Kubernetes Secret where the enrolled OpenZiti identity JSON is stored. |
| `openziti.hubApi.serviceName` | Name of the OpenZiti service used to expose the hub Kubernetes API. |
| `ziti-edge-tunnel.image.*` | Container image configuration for the OpenZiti tunneler. |
| `ziti-edge-tunnel.secret.existingSecretName` | Secret mounted by the tunneler. This should match `openziti.identity.secretName`. |
| `ziti-edge-tunnel.secret.keyName` | Key inside the Secret containing the OpenZiti identity JSON. |
The following two values must reference the same Kubernetes Secret:
```
openziti.identity.secretName
|
+----> generated by bootstrap Job
ziti-edge-tunnel.secret.existingSecretName
|
+----> consumed by ziti-edge-tunnel
```
**OCM Hub API through OpenZiti**
The hub chart creates the OpenZiti objects required to expose the Kubernetes API:
```
hub-ziti
|
| Bind
v
ocm-hub-api
|
+--> intercept.v1: HUB_IP:6443
|
+--> host.v1: HUB_IP:6443
```
The host.v1 configuration points to the actual Kubernetes API endpoint of the hub.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
The managed chart can later create cluster-specific Dial policies to consume this service if direct access to the hub API is unavailable.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
**Installation**
```
helm dependency update
```
```
helm install ocm-hub . \
-n ocm-hub \
--create-namespace \
--timeout 10m
```
**Verification**
Check the OCM hub:
```kubectl get clustermanager```
Check managed clusters:
```kubectl get managedclusters```
Check registration CSRs:
```kubectl get csr```
Check the OpenZiti tunneler:
```
kubectl get pods -n ocm-hub \
-l app.kubernetes.io/name=ziti-edge-tunnel
```
Check its logs:
```
kubectl logs -n ocm-hub \
-l app.kubernetes.io/name=ziti-edge-tunnel
```
**Adding or Removing Managed Clusters**
Update:
```
managedClusters:
- cluster1
- cluster2
```
Then apply:
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
```helm upgrade ocm-hub . -n ocm-hub```
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
The hub chart reconciles the configured list with the existing OCM ```ManagedCluster``` resources.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
**Uninstall**
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
```helm uninstall ocm-hub -n ocm-hub```
## License
For open source projects, say how it is licensed.
The cleanup hook removes:
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
- configured ManagedCluster resources;
- OCM hub resources;
- related CSRs and stale OCM resources;
- the OpenZiti hub service and configurations;
- the OpenZiti Bind policy;
- the hub-ziti identity;
- the generated identity Secret and bootstrap RBAC resources.
