README
¶
Welcome to the Cluster API Provider for Intel
Overview
The Cluster API Provider for Intel enables using the Cluster API framework to create Kubernetes clusters on hosts managed by the Edge Orchestrator. Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
The Cluster API Provider for Intel consists of two components: the Infrastructure Provider controllers and the Southbound Handler.
Get Started
The recommended way to try out the Cluster API Provider for Intel is by using the Edge Orchestrator. Refer to the Getting Started Guide to get started with the Edge Orchestrator.
Develop
If you are interested in contributing to the development of CAPI Provider for Intel, you will need an environment where you can use it to create and delete clusters.
The cluster-tests repo provides a lightweight environment for integration testing of the CAPI Provider for Intel as well as other Edge Orchestrator components related to cluster management. Clone that repo, change into the cluster-tests directory, and run:
make test
This command creates a KinD cluster and deploys cert-manager, Cluster API operator, CAPI Provider for Intel, Cluster Manager, and Cluster Connect Gateway. It then creates and deletes a cluster inside a Kubernetes pod. Consult the cluster-tests README for details on how to test your code in this environment.
Contribute
We welcome contributions from the community! To contribute, please open a pull request to have your changes reviewed and merged into the main. To learn how to contribute to the project, see the Contributor's Guide. We encourage you to add appropriate unit tests and e2e tests if your contribution introduces a new feature.
Additionally, ensure the following commands are successful:
make test
make lint
make license
Community and Support
To learn more about the project, its community, and governance, visit the Edge Orchestrator Community. For support, start with Troubleshooting or contact us.
License
Cluster API Provider Intel is licensed under Apache 2.0 License
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group. |
|
cmd
|
|
|
manager
command
|
|
|
southbound
command
|
|
|
internal
|
|
|
mocks
|
|
|
pkg
|
|
|
mocks/mock-secret-client
SPDX-FileCopyrightText: (C) 2023 Intel Corporation
|
SPDX-FileCopyrightText: (C) 2023 Intel Corporation |
|
rbac
Package rbac implements utility functions for Role-Based Access Control
|
Package rbac implements utility functions for Role-Based Access Control |
|
test
|
|