Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #738

Merged
merged 1 commit into from
Nov 5, 2024
Merged

Update README.md #738

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Instaclustr Operator
The Instaclustr Operator allows users to deploy, scale and manage any one of
data layer technologies deployed on the Instaclustr platform from Kubernetes.
data layer technologies deployed on the Instaclustr platform from within Kubernetes.

## Description
The Instaclustr Operator provides all the same functionality as the Instaclustr API,
Expand All @@ -13,17 +13,6 @@ Instaclustr Console and Instaclustr terraform provider.
- Simplify Kubernetes native development workflow patterns
(CI/CD integrations, production deployments etc).

## C4 model diagrams

| Context diagram | Container diagram | Component diagram|
|:-----------------------------------------------------------------------:|:--------------------------------------------------------:|:-------------------------:|
| ![Context diagram](doc/diagrams/context_diagram.png "Context diagram") | ![Container diagram](doc/diagrams/container_diagram.png) | ![Component diagram](doc/diagrams/component_diagram.png)|

| CRDs Relations |
| :---------------------------------------------------------------------: |
| ![CRD Relations](doc/diagrams/crd_relations.png "CRD Relations") |


## Getting Started
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.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
Expand Down Expand Up @@ -114,6 +103,19 @@ Please reach out to [email protected] for issues with this Instaclustr Ope

The support status of this project is available through https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/.


## C4 model diagrams

| Context diagram | Container diagram | Component diagram|
|:-----------------------------------------------------------------------:|:--------------------------------------------------------:|:-------------------------:|
| ![Context diagram](doc/diagrams/context_diagram.png "Context diagram") | ![Container diagram](doc/diagrams/container_diagram.png) | ![Component diagram](doc/diagrams/component_diagram.png)|

| CRDs Relations |
| :---------------------------------------------------------------------: |
| ![CRD Relations](doc/diagrams/crd_relations.png "CRD Relations") |



## License

Apache2 - See the included LICENSE file for more details.
Loading