From 17ddf60bfcc1ee902e4f712aabc54d7fb6f1b476 Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Mon, 22 Mar 2021 12:19:12 -0700 Subject: [PATCH] example: added README Signed-off-by: Sam Alba --- examples/README.md | 54 ++++++++++++++++++++++++++++++++++++++ examples/aws-eks/README.md | 12 --------- 2 files changed, 54 insertions(+), 12 deletions(-) create mode 100644 examples/README.md delete mode 100644 examples/aws-eks/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..3387f63b --- /dev/null +++ b/examples/README.md @@ -0,0 +1,54 @@ +# Dagger Examples + +## aws-eks: Kubernetes on AWS (EKS) + +This example provisions a Kubernetes (EKS) cluster on AWS using Cloudformation, +it also outputs the new generated kubeconfig for the `kubectl` client. + +How to run: + +```sh +dagger compute ./aws-eks \ + --input-string awsConfig.accessKey="MY_AWS_ACCESS_KEY" \ + --input-string awsConfig.secretKey="MY_AWS_SECRET_KEY" \ + | jq -j '.kubeconfig.kubeconfig' > kubeconfig +``` + +## aws-monitoring: HTTP Monitoring on AWS + +This example implements a full HTTP(s) Monitoring solution on AWS using +Cloudformation and Cloudwatch Synthetics. + +How to run: + +```sh +dagger compute ./aws-monitoring \ + --input-string awsConfig.accessKey="MY_AWS_ACCESS_KEY" \ + --input-string awsConfig.secretKey="MY_AWS_SECRET_KEY" \ +``` + +## kubernetes: Deploy to an existing Kubernetes cluster + +This example shows two different ways for deploying to an existing Kubernetes +(EKS) cluster: a simple deployment spec (written in Cue), and a local helm +chart. + +How to run: + +```sh +dagger compute ./kubernetes \ + --input-string awsConfig.accessKey="MY_AWS_ACCESS_KEY" \ + --input-string awsConfig.secretKey="MY_AWS_SECRET_KEY" \ + --input-dir helmChart.chart=./kubernetes/testdata/mychart +``` + +## react-netlify: Deploy a React Web app to Netlify + +This example shows how to deploy a simple React App to Netlify. + +How to run: + +```sh +dagger compute ./react-netlify \ + --input-string todoApp.account.token="MY_NETLIFY_API_TOKEN" +``` diff --git a/examples/aws-eks/README.md b/examples/aws-eks/README.md deleted file mode 100644 index dfc50a8b..00000000 --- a/examples/aws-eks/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Kubernetes on AWS (EKS) - -This example creates a new EKS cluster and outputs its corresponding kubeconfig - -## How to run - -```sh -dagger compute . \ - --input-string awsConfig.accessKey="MY_AWS_ACCESS_KEY" \ - --input-string awsConfig.secretKey="MY_AWS_SECRET_KEY" \ - | jq -j '.kubeconfig.kubeconfig' > kubeconfig -```