Skip to content

Commit 713f556

Browse files
authored
Merge pull request #308 from kbst/update-readme
Update README
2 parents cbffac7 + 08f53ce commit 713f556

File tree

1 file changed

+24
-40
lines changed

1 file changed

+24
-40
lines changed

README.md

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</p>
44

55
<h1 align="center">Kubestack</h1>
6-
<h3 align="center">The Open Source Gitops Framework</h3>
6+
<h3 align="center">The Open Source Terraform framework for Kubernetes Platform Engineering</h3>
77

88
<div align="center">
99

@@ -33,41 +33,18 @@
3333

3434
## Introduction
3535

36-
[Kubestack is a Gitops framework](https://www.kubestack.com) for managed Kubernetes services based on Terraform and Kustomize.
36+
[Kubestack is a Terraform framework for Kubernetes Platform Engineering](https://www.kubestack.com) teams to define the entire cloud native stack in one Terraform code base and continuously evolve the platform safely through GitOps.
3737

38-
### Features
39-
* Provides full testability of configuration changes
40-
* Clearly separates infrastructure and applications (`ops` & `apps` cluster pair)
41-
* Ensures K8s cluster config, surrounding infrastructure (e.g. DNS, IPs) and cluster services (e.g. Ingress) are maintained together
42-
* Unifies application environments across cloud providers
43-
* Increases deployment confidance through local deployments that accurately mirror cloud deployments
44-
* Enables a sustainable and fully automated GitOps workflow
38+
### Highlights
4539

40+
* [Convention over configuration platform engineering framework](https://www.kubestack.com/framework/documentation/) that makes the power of platforms accessible to your whole engineering team
41+
* [Platform architecture](https://www.kubestack.com/framework/documentation/platform-architecture/) and [GitOps workflow](https://www.kubestack.com/framework/documentation/gitops-process/) enabling all team members to safely iterate while protecting your application environments
42+
* [Extendable, future-proof, low-maintenance Terraform code base](https://www.kubestack.com/framework/documentation/extending-kubestack/) and robust automation even for complex Kubernetes platforms
4643

4744
## Getting Started
4845

49-
For the easiest way to get started, [visit the official Kubestack quickstart](https://www.kubestack.com/infrastructure/documentation/quickstart). This tutorial will help you get started with the Kubestack GitOps framework. It is divided into three steps.
50-
51-
1. Develop Locally
52-
* Scaffold your repository and tweak your config in a local development environment that simulates your actual cloud configuration using Kubernetes in Docker (KinD).
53-
3. Provision Infrastructure
54-
* Set-up cloud prerequisites and bootstrap Kubestack's environment and clusters on your cloud provider for the first time.
55-
4. Set-up Automation
56-
* Integrate CI/CD to automate changes following Kubestack's GitOps workflow.
57-
58-
See the [`tests`](./tests) directory for an example of how to extend this towards multi-cluster and/or multi-cloud.
59-
60-
61-
## Repository Layout
62-
63-
This repository holds Terraform modules in directories matching the respective provider name, e.g. [`aws`](./aws), [`azurerm`](./azurerm), [`google`](./google). Additionally [`common`](./common) holds the modules that are used for all providers. Most notably the [`metadata`](./common/metadata) module that ensures a consistent naming scheme and the `cluster_services` module which integrates Kustomize into the Terraform apply.
64-
65-
Each cloud provider specific module directory always has a `cluster`, `cluster-local`, and `_modules` directories. The cluster module is user facing and once Kubestack is out of beta the goal is to not change the module interface unless the major version changes. The cluster module then internally uses the module in `_modules` that holds the actual implementation. The cluster-local module is similar to the cluster module, but configured for local deployments.
66-
67-
The [`quickstart`](./quickstart) directory is home to the source for the zip files that are used to bootstrap the user repositories when following the quickstart documentation.
68-
69-
The [`tests`](./tests) directory holds a set of happy path tests that also act as a example of how to do multiple cluster pairs across multiple clouds from one repository.
70-
46+
For the easiest way to get started, [follow the Kubestack tutorial](https://www.kubestack.com/framework/tutorial/).
47+
The tutorial will help you get started with the Kubestack framework and build a Kubernetes platform application teams love.
7148

7249
## Getting Help
7350

@@ -77,11 +54,19 @@ Refer to the [official documentation](https://www.kubestack.com/framework/docume
7754
**Community Help**
7855
If you have any questions while following the tutorial, join the [#kubestack](https://app.slack.com/client/T09NY5SBT/CMBCT7XRQ) channel on the Kubernetes community. To create an account request an [invitation](https://slack.k8s.io/).
7956

80-
**Professional Services**
81-
For organizations interested in accelerating their GitOps journey, [professional services](https://www.kubestack.com/lp/professional-services) are available.
57+
## Contributing
8258

59+
This repository holds Terraform modules in directories matching the respective provider name, e.g. [`aws`](./aws), [`azurerm`](./azurerm), [`google`](./google). Additionally [`common`](./common) holds the modules that are used for all providers.
60+
Most notably the [`metadata`](./common/metadata) module that ensures a consistent naming scheme and the `cluster_services` module which integrates Kustomize into the Terraform apply.
61+
62+
Each cloud provider specific module directory always has a `cluster` and `_modules` directories.
63+
The cluster module is user facing and once Kubestack is out of beta the goal is to not change the module interface unless the major version changes.
64+
The cluster module then internally uses the module in `_modules` that holds the actual implementation.
65+
66+
The [`quickstart`](./quickstart) directory is home to the source for the zip files that are used to bootstrap the user repositories when following the tutorial.
67+
68+
The [`tests`](./tests) directory holds a set of happy path tests.
8369

84-
## Contributing
8570
Contributions to the Kubestack framework are welcome and encouraged. Before contributing, please read the [Contributing](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) Guidelines.
8671

8772
One super simple way to contribute to the success of this project is to give it a star.
@@ -92,14 +77,13 @@ One super simple way to contribute to the success of this project is to give it
9277

9378
</div>
9479

95-
9680
## Kubestack Repositories
81+
9782
* [kbst/terraform-kubestack](https://github.com/kbst/terraform-kubestack) (this repository)
98-
* Terraform GitOps Framework - Everything you need to build reliable automation for AKS, EKS and GKE Kubernetes clusters in one free and open-source framework.
83+
* [Terraform framework for Kubernetes Platform Engineering](https://www.kubestack.com/) teams - Define your entire cloud native Kubernetes stack in one Terraform code base and continuously evolve the platform safely through GitOps.
9984
* [kbst/kbst](https://github.com/kbst/kbst)
100-
* Kubestack Framework CLI - All-in-one CLI to scaffold your Infrastructure as Code repository and deploy your entire platform stack locally for faster iteration.
85+
* Kubestack CLI `kbst` - The CLI helps you scaffold the Terraform code that defines the clusters, node pools or services of your platform. The CLI works on local files only, you can see any change it makes with git status.
10186
* [kbst/terraform-provider-kustomization](https://github.com/kbst/terraform-provider-kustomization)
102-
* Kustomize Terraform Provider - A Kubestack maintained Terraform provider for Kustomize, available in the [Terraform registry](https://registry.terraform.io/providers/kbst/kustomization/latest).
87+
* Kustomize Terraform Provider - A Kubestack maintained Terraform provider for Kustomize, available in the [Terraform registry](https://registry.terraform.io/providers/kbst/kustomization/latest).
10388
* [kbst/catalog](https://github.com/kbst/catalog)
104-
* Catalog of cluster services as Kustomize bases - Continuously tested and updated Kubernetes services, installed and customizable using native Terraform syntax.
105-
89+
* Catalog of Terraform modules for Kubernetes platforms - The [Kubestack Terraform modules](https://www.kubestack.com/catalog/) make it easy for platform engineering teams to deliver common platform features in production ready configurations.

0 commit comments

Comments
 (0)