Cluster API Provider Outscale (CAPOSC)

---

🌐 Links

• 📘 Documentation: Getting Started
• 🛠 Developer Guide: Development
• 🤝 Contribution Guide: CONTRIBUTING.md
• 🌐 Cluster API website: https://cluster-api.sigs.k8s.io
• 💬 Join us on Discord

---

📄 Table of Contents

• Overview
• Project Status
• Requirements
• Installation
• Usage
• Development
• Contributing
• License

---

🧭 Overview

Cluster API Provider Outscale (CAPOSC) enables Kubernetes-native declarative infrastructure management on the OUTSCALE Cloud using Cluster API.

With CAPOSC, you can provision and manage Kubernetes clusters on OUTSCALE like any other Kubernetes resource—declaratively and at scale.

---

🚧 Project Status

This project is currently in alpha. Features and APIs are subject to change. Use with caution in production environments.

---

✅ Requirements

• Kubernetes 1.26+
• clusterctl CLI
• An OUTSCALE account with API credentials
• Internet access for cluster provisioning

---

⚙️ Installation

Install clusterctl and initialize the management cluster with CAPOSC components.

Refer to the getting started guide:

kubectl create namespace capa-outscale-system
clusterctl init --infrastructure outscale

📘 See full instructions: Getting Started with clusterctl

---

🚀 Usage

Once initialized, you can manage workload clusters declaratively using Kubernetes manifests.

Example:

apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
  name: example-cluster
spec:
  ...

Apply with:

kubectl apply -f cluster.yaml

Nodes are deployed using a Kubernetes OMI image. An open-source image builder has been developped by the Kubernetes community.

To simplify the use of cluster-api, images are published on Outscale Open-source accounts.

As the images are produced by an open-source builder, there is no guarantee that clusters created with these images will be fully functional, and no official support is provided by Outscale on those images.

The list of published images may be found either in Cockpit or on the builder automation repository releases page.

---

🛠 Development

To set up your environment for development or to build from source, follow the steps in the Development Guide.

---

🤝 Contributing

We welcome community contributions!

Please read our CONTRIBUTING.md guide to learn how to propose improvements, report issues, or open pull requests.

---

📜 License

CAPOSC is licensed under the BSD 3-Clause License.

© 2025 Outscale SAS

This project complies with the REUSE Specification.

See LICENSES/ directory for full license information.