karpenter-provider-ibm-cloud

README

Karpenter Provider for IBM Cloud

This repository contains the Karpenter Provider implementation for IBM Cloud, enabling dynamic node provisioning in IBM Cloud Kubernetes clusters using Karpenter.

Overview

Karpenter is an open-source node provisioning project for Kubernetes. This provider extends Karpenter's functionality to work with IBM Cloud, allowing for:

• Dynamic node provisioning in IBM Cloud VPC
• Instance type management and selection
• Automated scaling based on workload demands
• Integration with IBM Cloud APIs

Prerequisites

Before installing the provider, ensure you have:

1. An IBM Cloud account with necessary permissions
2. IBM Cloud CLI installed
3. A Kubernetes cluster running on IBM Cloud
4. Required API keys:
   • IBM Cloud API key (for general IBM Cloud operations)
   • IAM API key (for VPC and Global Catalog APIs)

Creating Required API Keys

Create an IBM Cloud API key:

ibmcloud iam api-key-create MyKey -d "Karpenter IBM Cloud Provider Key" --file key_file

Installation

Installing the Operator

1. Add the Helm repository:

   helm repo add karpenter-ibm-cloud https://pfeifferj.github.io/karpenter-provider-ibm-cloud/index.yaml
   helm repo update
   

2. Install using Helm:

   helm install karpenter-ibm-cloud karpenter-ibm-cloud/karpenter-ibm-cloud \
     --namespace karpenter \
     --create-namespace \
     --set ibmCloud.apiKey=<your-api-key>
   

The required API keys and configuration can be set either through the values file or using the Helm CLI's --set flag during installation.

Configuration

The provider can be configured through the following custom resources:

• IBMCloudNodeClass: Defines the configuration for nodes to be provisioned
• NodePool: Karpenter's core resource for defining node provisioning rules
• NodeClaim: Represents a request for a node with specific requirements

Example IBMCloudNodeClass:

apiVersion: karpenter.ibm-cloud.sh/v1alpha1
kind: IBMCloudNodeClass
metadata:
  name: default
spec:
  region: us-south
  zone: us-south-1
  instanceProfile: bx2-2x8

Contributing

Contributions are welcome! Please read our Contributing Guidelines for details on how to submit pull requests.

License

This project is licensed under the Apache 2 License.