Skip to content

Commit 18e0121

Browse files
Merge pull request #617 from openstack-k8s-operators/add-overview-and-description-to-readme
Add short synopsis and description to README
2 parents 33e3b7e + 4e4903a commit 18e0121

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# infra-operator
2-
// TODO(user): Add simple overview of use/purpose
2+
3+
A Kubernetes operator for managing OpenStack infrastructure components.
34

45
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
6+
7+
The infra-operator manages essential infrastructure services for OpenStack deployments running on Kubernetes. It provides custom resource definitions (CRDs) and controllers for RabbitMQ messaging infrastructure, caching services (Memcached and Redis), network components (DNSMasq, IP management, BGP configuration), instance high availability, and topology management. Built using the Kubernetes operator pattern, it continuously reconciles the desired state of infrastructure resources.
68

79
## Getting Started
810
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
@@ -48,7 +50,7 @@ make undeploy
4850
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
4951

5052
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
51-
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
53+
which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster
5254

5355
### Test It Out
5456
1. Install the CRDs into the cluster:

0 commit comments

Comments
 (0)