-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
288 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,4 @@ | ||
| # Developer Guide | ||
|
|
||
| - [Rapid iterative development with Tilt](/developer/tilt.html) | ||
| - [Release process](/developer/release.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,78 @@ | ||
| # Getting Started | ||
|
|
||
| For prerequisites, check the respective sections for [VPC](topics/vpc/prerequisites.md) and [PowerVS](topics/powervs/prerequisites.md) | ||
|
|
||
| Now that we’ve got all the prerequisites in place, let’s create a Kubernetes cluster and transform | ||
| it into a management cluster using `clusterctl`. | ||
|
|
||
| ### Provision local boostrap management cluster: | ||
|
|
||
| 1. Create simple, local bootstrap cluster with a control-plane and worker node | ||
|
|
||
| Using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/): | ||
|
|
||
| ```console | ||
| ~ kind create cluster --name my-bootstrap --config bootstrap.yaml | ||
| ``` | ||
|
|
||
| Example bootstrap.yaml: | ||
| ```yaml | ||
| kind: Cluster | ||
| apiVersion: kind.x-k8s.io/v1alpha4 | ||
| nodes: | ||
| - role: control-plane | ||
| - role: worker | ||
| ``` | ||
|
|
||
| Make sure the nodes are in `Ready` state before moving on. | ||
|
|
||
| ```console | ||
| ~ kubectl get nodes | ||
| NAME STATUS ROLES AGE VERSION | ||
| my-bootstrap-control-plane Ready control-plane,master 46h v1.20.2 | ||
| my-bootstrap-worker Ready <none> 46h v1.20.2 | ||
| ``` | ||
|
|
||
| 2. Set workload cluster environment variables | ||
|
|
||
| Make sure these value reflects your API Key for your target VPC environment | ||
| or PowerVS environment in IBM Cloud. | ||
|
|
||
| ```console | ||
| export IBMCLOUD_API_KEY=<YOUR_API_KEY> | ||
| ``` | ||
| - Additional varibles required for VPC | ||
| The sample `IAM_ENDPOINT` below points to Production and the `SERVICE_ENDPOINT` points to the `us-east` VPC region. | ||
|
|
||
| ```console | ||
| export IAM_ENDPOINT=https://iam.cloud.ibm.com/identity/token | ||
| export SERVICE_ENDPOINT=https://us-south.iaas.cloud.ibm.com/v1 | ||
| ``` | ||
|
|
||
| 3. Initialize local bootstrap cluter as a management cluster | ||
| When executed for the first time, the following command accepts the infrasturcture provider as an input to install. `clusterctl init` automatically adds to the list the cluster-api core provider, and if unspecified, it also adds the kubeadm bootstrap and kubeadm control-plane providers, thereby converting it into a management cluster which will be used to provision a workload cluster in IBM Cloud. | ||
|
|
||
| ```console | ||
| ~ clusterctl init --infrastructure ibmcloud:<TAG> | ||
| ``` | ||
|
|
||
| Output: | ||
| ```console | ||
| Fetching providers | ||
| Installing cert-manager Version="v1.5.3" | ||
| Waiting for cert-manager to be available... | ||
| Installing Provider="cluster-api" Version="v0.4.4" TargetNamespace="capi-system" | ||
| Installing Provider="bootstrap-kubeadm" Version="v0.4.4" TargetNamespace="capi-kubeadm-bootstrap-system" | ||
| Installing Provider="control-plane-kubeadm" Version="v0.4.4" TargetNamespace="capi-kubeadm-control-plane-system" | ||
| Installing Provider="infrastructure-ibmcloud" Version="v0.1.0-alpha.2" TargetNamespace="capi-ibmcloud-system" | ||
|
|
||
| Your management cluster has been initialized successfully! | ||
|
|
||
| You can now create your first workload cluster by running the following: | ||
|
|
||
| clusterctl generate cluster [name] --kubernetes-version [version] | kubectl apply -f - | ||
| ``` | ||
|
|
||
| 5. Once the management cluster is ready with the required providers up and running, proceed to provisioning the workload cluster. Check the respective sections for [VPC](/topics/vpc/creating-a-cluster.html) and [PowerVS](/topics/powervs/creating-a-cluster.html) to deploy the cluster. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,92 @@ | ||
| # Introduction | ||
| # Kubernetes Cluster API Provider IBM Cloud | ||
|
|
||
| <p align="center"> | ||
| <img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png" width="100x"> | ||
| <img src="../images/ibm-cloud.svg" height="100x" width="200x" alt="IBM Cloud"> | ||
| </p> | ||
|
|
||
| ------ | ||
| <p align="center">Kubernetes-native declarative infrastructure for IBM Cloud.</p> | ||
|
|
||
| ## What is the Cluster API Provider IBM Cloud | ||
|
|
||
|
|
||
| The [Cluster API](https://github.com/kubernetes-sigs/cluster-api) brings declarative, Kubernetes-style APIs to cluster creation, configuration and management. | ||
|
|
||
| The API itself is shared across multiple cloud providers allowing for true IBM Cloud | ||
| hybrid deployments of Kubernetes. It is built atop the lessons learned from | ||
| previous cluster managers such as [kops](https://github.com/kubernetes/kops) and | ||
| [kubicorn](http://kubicorn.io/). | ||
|
|
||
| ## Quick Start | ||
|
|
||
| Check out the [getting started](./getting-started.html) section to create your first Kubernetes cluster on IBM Cloud using Cluster API. | ||
|
|
||
| ## Tilt-based development environment | ||
|
|
||
| See [developer guide](/developer/tilt.html) section for details. | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| Please see our [Book](https://cluster-api-ibmcloud.sigs.k8s.io) for in-depth user documentation. | ||
|
|
||
| Additional docs can be found in the `/docs` directory, and the [index is here](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/tree/main/docs). | ||
|
|
||
| ## Getting involved and contributing | ||
|
|
||
| Are you interested in contributing to cluster-api-provider-ibmcloud? We, the | ||
| maintainers and community, would love your suggestions, contributions, and help! | ||
| Also, the maintainers can be contacted at any time to learn more about how to get | ||
| involved. | ||
|
|
||
| In the interest of getting more new people involved, we tag issues with | ||
| [`good first issue`](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/issues?q=is%3Aissue+label%3A%22good+first+issue%22+is%3Aopen). | ||
| These are typically issues that have smaller scope but are good ways to start | ||
| to get acquainted with the codebase. | ||
|
|
||
| We also encourage all active community participants to act as if they are | ||
| maintainers, even if you don't have "official" write permissions. This is a | ||
| community effort, we are here to serve the Kubernetes community. If you have an | ||
| active interest and you want to get involved, you have real power! Don't assume | ||
| that the only people who can get things done around here are the "maintainers". | ||
|
|
||
| We also would love to add more "official" maintainers, so show us what you can | ||
| do! | ||
|
|
||
| This repository uses the Kubernetes bots. See a full list of the commands [here](https://prow.k8s.io/command-help). | ||
|
|
||
| ### Join us | ||
|
|
||
| The community holds a weekly meeting every Friday at 09:00 (IST) / 03:30 (UTC) on [Zoom](https://zoom.us/j/9392903494). Subscribe to the [SIG Cluster Lifecycle](https://groups.google.com/g/kubernetes-sig-cluster-lifecycle) Google Group for access to documents and calendars | ||
|
|
||
|
|
||
| ### Other ways to communicate with the contributors | ||
|
|
||
| Please check in with us in the [#cluster-api-ibmcloud](https://kubernetes.slack.com/archives/C02F4CX3ALF) channel on Slack. | ||
|
|
||
| ## Github issues | ||
|
|
||
| ### Bugs | ||
|
|
||
| If you think you have found a bug please follow the instructions below. | ||
|
|
||
| - Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. | ||
| - Get the logs from the cluster controllers. Please paste this into your issue. | ||
| - Open a [bug report](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/issues/new?assignees=&labels=&template=bug_report.md). | ||
| - Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others. | ||
|
|
||
| ### Tracking new features | ||
|
|
||
| We also use the issue tracker to track features. If you have an idea for a feature, or think you can help Cluster API Provider IBMCloud become even more awesome, then follow the steps below. | ||
|
|
||
| - Open a [feature request](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/issues/new?assignees=&labels=&template=feature_request.md). | ||
| - Remember users might be searching for your issue in the future, so please | ||
| give it a meaningful title to helps others. | ||
| - Clearly define the use case, using concrete examples. EG: I type `this` and | ||
| cluster-api-provider-ibmcloud does `that`. | ||
| - Some of our larger features will require some design. If you would like to | ||
| include a technical design for your feature please include it in the issue. | ||
| - After the new feature is well understood, and the design agreed upon we can | ||
| start coding the feature. We would love for you to code it. So please open | ||
| up a **WIP** *(work in progress)* pull request, and happy coding. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| # Topics | ||
|
|
||
| This section contains information about using IBM Cloud features with Cluster API Provider IBM Cloud. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,5 @@ | ||
| # Power VS Cluster | ||
|
|
||
| ## Contents | ||
| - [Prerequisites](/topics/powervs/prerequisites.html) | ||
| - [Creating a cluster](/topics/powervs/creating-a-cluster.html) |
Oops, something went wrong.