diff --git a/README.md b/README.md index 85aa552a60..45a39abd15 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ [![Release](https://img.shields.io/github/v/release/weaveworks/weave-gitops?include_prereleases)](https://github.com/weaveworks/weave-gitops/releases/latest) [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B19155%2Fgithub.com%2Fweaveworks%2Fweave-gitops.svg?type=shield)](https://app.fossa.com/reports/005da7c4-1f10-4889-9432-8b97c2084e41) -Weave GitOps is a simple open source developer platform for people who want cloud native applications, without needing -Kubernetes expertise. Experience how easy it is to enable GitOps and run your apps in a cluster. Use git to collaborate +Weave GitOps is a simple, open source developer platform for people who want cloud native applications but who don't have +Kubernetes expertise. Experience how easy it is to enable GitOps and run your apps in a cluster. Use Git to collaborate with team members making new deployments easy and secure. Start with what developers need to run apps, and then easily extend to define and run your own enterprise platform. @@ -15,34 +15,46 @@ From Kubernetes run Weave GitOps to get: 1. Application Operations: manage and automate deployment pipelines for apps and more 2. Platforms: the easy way to have your own custom PaaS on cloud or on premise -3. Extensions: coordinate Kubernetes rollouts with eg. VMs, DBs and cloud services +3. Extensions: coordinate Kubernetes rollouts with eg. VMs, databases, and cloud services -Our vision is that all cloud native applications should be easy for developers, including operations which should be +Our vision is that all cloud native applications should be easy for developers, and that operations should be automated and secure. Weave GitOps is a highly extensible tool to achieve this by placing Kubernetes and GitOps at the core and building a platform around that. -We use GitOps tools throughout. Today Weave GitOps defaults are Flux, Kustomize, Helm, Sops and Kubernetes CAPI. If you -use Flux already then you can easily add Weave GitOps to create a platform management overlay. +Weave GitOps defaults are [Flux](https://fluxcd.io/flux/) as the GitOps engine, Kustomize, Helm, Sops, and Kubernetes CAPI. If you use Flux already, then you can easily add Weave GitOps to create a platform management overlay. + +Weave GitOps Open Source provides: + +- Continuous Delivery through GitOps for apps and infrastructure. +- Support for GitHub, GitLab, and Bitbucket; S3-compatible buckets as a source; all major container registries; and all CI workflow providers. +- A secure, pull-based mechanism, operating with least amount of privileges, and adhering to Kubernetes security policies. +- Compatibility with any conformant Kubernetes version and common ecosystem technologies such as Helm, Kustomize, RBAC, Prometheus, OPA, Kyverno, etc. +- Multitenancy, multiple Git repositories, multiple clusters. +- Alerts and notifications. ### Manage and view applications all in one place. ![Application Page](./doc/img/01-workloads.png) -### Easily see your continuous deployments and what is being produced via GitOps. There are multiple views for debugging as well as being able to sync your latest git commits directly from the UI. +### Easily see your continuous deployments and what is being produced via GitOps. There are multiple views for debugging as well as being able to sync your latest Git commits directly from the UI. ![Reconciliation Page](./doc/img/02-workload-detail.png) -### Leverage Kubernetes RBAC to control permissions in the dashboard. +### Check out the Graph view. + +![Graph View](./doc/img/03-graph.png) + +### Review the yaml file. -![Source Page](./doc/img/03-rbac.jpg) +![Yaml View](./doc/img/04-yaml.png) ### See your entire source landscape whether it is a git repository, helm repository, or bucket. -![Flux Runtime](./doc/img/04-sources.jpg) +![Sources view](./doc/img/05-sources.png) ### Quickly see the health of your reconciliation deployment runtime. These are the workers that are ensuring your software is running on the Kubernetes cluster. -![Flux Runtime](./doc/img/05-runtime.jpg) +![Flux Runtime](./doc/img/06-runtime.png) ## Getting Started diff --git a/doc/img/01-workloads.png b/doc/img/01-workloads.png index 0ea8981514..961daa8aa0 100644 Binary files a/doc/img/01-workloads.png and b/doc/img/01-workloads.png differ diff --git a/doc/img/02-workload-detail.png b/doc/img/02-workload-detail.png index 06e6c633e2..386c44a3a2 100644 Binary files a/doc/img/02-workload-detail.png and b/doc/img/02-workload-detail.png differ diff --git a/doc/img/03-graph.png b/doc/img/03-graph.png new file mode 100644 index 0000000000..13fbabf44f Binary files /dev/null and b/doc/img/03-graph.png differ diff --git a/doc/img/03-rbac.jpg b/doc/img/03-rbac.jpg deleted file mode 100644 index 3ac9ba1f02..0000000000 Binary files a/doc/img/03-rbac.jpg and /dev/null differ diff --git a/doc/img/04-sources.jpg b/doc/img/04-sources.jpg deleted file mode 100644 index 5bf4e1c6cb..0000000000 Binary files a/doc/img/04-sources.jpg and /dev/null differ diff --git a/doc/img/04-yaml.png b/doc/img/04-yaml.png new file mode 100644 index 0000000000..b7dd5f1ce3 Binary files /dev/null and b/doc/img/04-yaml.png differ diff --git a/doc/img/05-runtime.jpg b/doc/img/05-runtime.jpg deleted file mode 100644 index 2e4f11f47e..0000000000 Binary files a/doc/img/05-runtime.jpg and /dev/null differ diff --git a/doc/img/05-sources.png b/doc/img/05-sources.png new file mode 100644 index 0000000000..b060160754 Binary files /dev/null and b/doc/img/05-sources.png differ diff --git a/doc/img/06-runtime.png b/doc/img/06-runtime.png new file mode 100644 index 0000000000..08b6bd00f1 Binary files /dev/null and b/doc/img/06-runtime.png differ