diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 1ee27c5..e22b98c 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -1,5 +1,5 @@ # -name: Create and publish a Docker image +name: main-build on: push: diff --git a/README.md b/README.md index 818d4bc..f77cf69 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ -# Dynamic Environment Controller Dynamic Environment Logo +

+

Dynamic Environment

-A k8s operator which supports testing on a multi-test workflows environment in a -transparent way. This operator will listen to DynamicEnv, a new Riskified custom resource. -In this resource we will configure the services from which we want to create a subset with new version of our app -and apply all the requirements for routing the requests to the matching subsets. -Ready to get started? Check out the [docs](https://riskified.github.io/dynamic-environment-docs/). +

+ main build + GitHub release + License +

-## Setting Development Environment +DynamicEnv is an innovative Kubernetes operator designed to empower developers by simplifying the process of launching on-demand environments. At its core, DynamicEnv offers a streamlined approach to deploying and testing different versions of specific services within a shared Kubernetes cluster. + +It effectively deals with the issues mentioned by creating special versions just for the services being tested. At the same time, it makes smart use of the 'production' versions for the rest of the environment, ensuring efficient resource use. The traffic is cleverly directed, sending 'real' users to the 'production' version of services and directing the traffic of a test user to the specific test version. + +

+ +

+
+ Explore the docs ยป +
+

+ +## Development Setup This section describes how to create a working environment for developing _Dynamic Environment_. While it's not mandatory to follow these instructions or use the same tools, it's highly recommended @@ -46,7 +59,7 @@ Here are other tools, that while not required, can make life easier: * `k9s`: A great tool for interacting with k8s from the command line. Check the [website][k9s] for usage. -## Prepare task +### Prepare task Some of the development requirements are installed via the `Makefile`'s `prepare` task. Run it to install requirements: @@ -55,14 +68,14 @@ install requirements: make prepare ``` -### Kubernetes Setup for Development and Testing +## Setting up Kubernetes After we have the tools we need, it's time to install two kubernetes clusters. One for Development and one for running tests locally. Below is an optional suggestion for installing and configuring these clusters. Feel free to replace all the components except _KInd_ (so your test setup will be as similar to the _CI_ as possible). -#### Development Cluster +### Development Cluster We will use [minikube][] as our development cluster. Feel free to use whichever cluster suits you best, but try to preserve the kubernetes version. diff --git a/images/DynamicEnv-logo.png b/images/DynamicEnv-logo.png new file mode 100644 index 0000000..11b27b7 Binary files /dev/null and b/images/DynamicEnv-logo.png differ diff --git a/images/de-in-action.png b/images/de-in-action.png new file mode 100644 index 0000000..1711199 Binary files /dev/null and b/images/de-in-action.png differ