Skip to content
This repository was archived by the owner on Feb 16, 2024. It is now read-only.

Commit 02ce0fc

Browse files
author
Vladislav Supalov
committed
Improve README (#264)
## Description This PR adds a hard-coded, slightly modified version of our operator READMEs, providing a better entry point into the Stackable ecosystem.
1 parent bc61b82 commit 02ce0fc

File tree

3 files changed

+114
-5
lines changed

3 files changed

+114
-5
lines changed
Lines changed: 20 additions & 0 deletions
Loading
214 KB
Loading

README.md

Lines changed: 94 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,96 @@
1-
# stackablectl
1+
<p align="center">
2+
<img width="150" src="./.readme/static/borrowed/Icon_Stackable.svg" alt="Stackable Logo"/>
3+
</p>
24

3-
The documentation of `stackablectl` can be found in the [documentation of the Stackable Data Platform](https://docs.stackable.tech/stackablectl/stable/index.html).
5+
<h1 align="center">Stackablectl</h1>
46

5-
# TODOs
6-
* Check if CRD resources still exist when uninstalling the operators. If so warn the user.
7-
* Use Result instead of panic!() in multiple places
7+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stackabletech/druid-operator/graphs/commit-activity)
8+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
9+
[![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)
10+
11+
[Documentation](https://docs.stackable.tech/stackablectl/stable/index.html) | [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
12+
13+
This repository is the home of the CLI application `stackablectl`, which makes it convenient to setup and interact with any Stackable cluster.
14+
15+
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Kafka, Druid, Trino or Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud](#supported-platforms).
16+
17+
## Installation
18+
19+
To install stackablectl, follow the instructions [in the docs](https://docs.stackable.tech/stackablectl/stable/installation.html).
20+
21+
## Getting Started
22+
23+
You can find a usage example in this [tutorial](https://docs.stackable.tech/stackablectl/stable/quickstart.html).
24+
25+
## Documentation
26+
27+
The stable documentation for this tool can be found [here](https://docs.stackable.tech/stackablectl/stable/installation.html).
28+
29+
The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech).
30+
31+
If you have a question about the Stackable Data Platform contact us via our [homepage](https://stackable.tech/) or ask a public questions in our [Discussions forum](https://github.com/orgs/stackabletech/discussions).
32+
33+
34+
## About The Stackable Data Platform
35+
36+
This operator is written and maintained by [Stackable](https://www.stackable.tech) and it is part of a larger data platform.
37+
38+
![Stackable Data Platform Overview](./.readme/static/borrowed/sdp_overview.png)
39+
40+
Stackable makes it easy to operate data applications in any Kubernetes cluster.
41+
42+
The data platform offers many operators, new ones being added continuously. All our operators are designed and built to be easily interconnected and to be consistent to work with.
43+
44+
The [Stackable GmbH](https://stackable.tech/) is the company behind the Stackable Data Platform. Offering professional services, paid support plans and custom development.
45+
46+
We love open-source!
47+
48+
## Supported Platforms
49+
50+
We develop and test our operators on the following cloud platforms:
51+
52+
* AKS on Microsoft Azure
53+
* EKS on Amazon Web Services (AWS)
54+
* GKE on Google Cloud Platform (GCP)
55+
* [IONOS Cloud Managed Kubernetes](https://cloud.ionos.com/managed/kubernetes)
56+
* K3s
57+
* Kubernetes 1.23-1.26
58+
59+
We are currently working to support:
60+
61+
* OpenShift
62+
63+
## Our Operators
64+
65+
These are the operators that are currently part of the Stackable Data Platform:
66+
67+
* [Stackable Operator for Apache Airflow](https://github.com/stackabletech/airflow-operator)
68+
* [Stackable Operator for Apache Druid](https://github.com/stackabletech/druid-operator)
69+
* [Stackable Operator for Apache HBase](https://github.com/stackabletech/hbase-operator)
70+
* [Stackable Operator for Apache Hadoop HDFS](https://github.com/stackabletech/hdfs-operator)
71+
* [Stackable Operator for Apache Hive](https://github.com/stackabletech/hive-operator)
72+
* [Stackable Operator for Apache Kafka](https://github.com/stackabletech/kafka-operator)
73+
* [Stackable Operator for Apache NiFi](https://github.com/stackabletech/nifi-operator)
74+
* [Stackable Operator for Apache Spark](https://github.com/stackabletech/spark-k8s-operator)
75+
* [Stackable Operator for Apache Superset](https://github.com/stackabletech/superset-operator)
76+
* [Stackable Operator for Trino](https://github.com/stackabletech/trino-operator)
77+
* [Stackable Operator for Apache ZooKeeper](https://github.com/stackabletech/zookeeper-operator)
78+
79+
And our internal operators:
80+
81+
* [Commons Operator](https://github.com/stackabletech/commons-operator)
82+
* [Listener Operator](https://github.com/stackabletech/listener-operator)
83+
* [OpenPolicyAgent Operator](https://github.com/stackabletech/opa-operator)
84+
* [Secret Operator](https://github.com/stackabletech/secret-operator)
85+
86+
## Contributing
87+
88+
Contributions are welcome. Follow our [Contributors Guide](https://docs.stackable.tech/home/stable/contributor/index.html) to learn how you can contribute.
89+
90+
## License
91+
92+
[Open Software License version 3.0](./LICENSE).
93+
94+
## Support
95+
96+
You can use this project under different licenses. Get started with the community edition! If you want professional support, [we offer subscription plans](https://stackable.tech/en/plans/).

0 commit comments

Comments
 (0)