Skip to content

Commit 432b312

Browse files
committed
Readme changes - Kind intro
1 parent 5265e82 commit 432b312

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Automated Test Environment for AKS Applications
22

3-
Framework to create Automated Test Environment using [kind](https://kind.sigs.k8s.io/) for testing Azure Kubernetes Service (AKS) based applications in CI (Continuous Integration) Pipeline (Azure DevOps), where required dependencies/infrastructure will be provisioned for executing automated tests and deprovisioned after completion.
3+
Framework to create Automated Test Environment using [KIND](https://kind.sigs.k8s.io/) for testing Azure Kubernetes Service (AKS) based applications in CI (Continuous Integration) Pipeline (Azure DevOps), where required dependencies/infrastructure will be provisioned for executing automated tests and deprovisioned after completion.
4+
5+
Testing the applications to be deployed over Kubernetes means either the Cluster is already available or is to be deployed on the go before you test, in former case its a cost to keep the Cluster live and in later it takes a lot of time to bring up the kubernetes cluster.
6+
7+
This framework uses [KIND](https://kind.sigs.k8s.io/) which itself was primarily designed for testing Kubernetes itself. KIND is often used by developers to test their applications in local dev environments and can very well be used for automated testing.
48

59
## Tools Used
6-
1. [kind](https://kind.sigs.k8s.io/) - a tool for running local Kubernetes clusters using Docker container “nodes”.
10+
1. [KIND](https://kind.sigs.k8s.io/) - a tool for running local Kubernetes clusters using Docker container “nodes”
711
2. [helm](https://helm.sh/) - the package manager for Kubernetes
812
3. [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) - command line tool to control Kubernetes clusters
913
4. [bash](https://www.gnu.org/software/bash/) - the GNU Project's shell
@@ -12,7 +16,7 @@ Framework to create Automated Test Environment using [kind](https://kind.sigs.k8
1216

1317
This is a very simple Framework, that creates Automated Test Environment to enable automated testing of applications hosted in [Azure Kubernetes Service (AKS)](https://docs.microsoft.com/en-us/azure/aks/) with the following features -
1418

15-
1. Create/Delete `kind` cluster in CI environment
19+
1. Create/Delete `KIND` cluster in CI environment
1620
2. Optional - [Azure Key Vault Provider for Secrets Store CSI Driver](https://github.com/Azure/secrets-store-csi-driver-provider-azure) [installation](https://github.com/Azure/secrets-store-csi-driver-provider-azure#install-the-secrets-store-csi-driver-and-the-azure-keyvault-provider) and [configuration](https://github.com/Azure/secrets-store-csi-driver-provider-azure/blob/master/docs/service-principal-mode.md)
1721
3. Optional - [Azure Container Registry (ACR) Image Pull Secret](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-auth-kubernetes#create-an-image-pull-secret)
1822
4. Install `helm` charts of application (values needed for integration test environment can be overwritten easily)
@@ -50,7 +54,7 @@ This framework contains the following script and their options -
5054
# --kubectl-check-services-selector-label=<ex. app.kubernetes.io/name or name etc.> (default app.kubernetes.io/name)
5155
# --kubectl-port-forward-services=<","(comma) seprated Service names needed to port-forward for testing>
5256
```
53-
3. `stop.sh`: Delete `kind` cluster -
57+
3. `stop.sh`: Delete `KIND` cluster -
5458
```sh
5559
# Usage: bash -f ./stop.sh
5660
# Supported Options -

0 commit comments

Comments
 (0)