Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add hello-kubernetes multi-app run k8s template #926

Merged
merged 2 commits into from
Oct 3, 2023

Conversation

mukundansundar
Copy link
Contributor

@mukundansundar mukundansundar commented Sep 22, 2023

Description

closes #914

Issue reference

We strive to have all PRs being opened based on an issue, where the problem or feature have been discussed prior to implementation.

Please reference the issue this PR will close: #[issue number]

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • The quickstart code compiles correctly
  • You've tested new builds of the quickstart if you changed quickstart code
  • You've updated the quickstart's README if necessary
  • If you have changed the steps for a quickstart be sure that you have updated the automated validation accordingly. All of our quickstarts have annotations that allow them to be executed automatically as code. For more information see mechanical-markdown. For user guide with examples see Examples.

@mukundansundar
Copy link
Contributor Author

interesting that the validation succeeds for multi-app-run k8s but fails for the normal run ... the issue being that python app fails to deploy... will investigate more on Monday.

The first thing you need is an RBAC enabled Kubernetes cluster. This could be running on your machine using Minikube, or it could be a fully-fledged cluster in Azure using [AKS](https://azure.microsoft.com/en-us/services/kubernetes-service/).

Once you have a cluster, follow the steps below to deploy Dapr to it. For more details, see [Deploy Dapr on a Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/).
## Using Dapr Mutli-app run
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be more descriptive with this title? This is actually two steps right?

  1. Installing Dapr runtime and all of the dependencies (redis , zipkin)
  2. Dapr run using multi-app run file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to Using Dapr Mutli-app run with Dapr `dev` mode deployment

Once you have a cluster, follow the steps below to deploy Dapr to it. For more details, see [Deploy Dapr on a Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/).
## Using Dapr Mutli-app run

### Step 1 - Setup Dapr dev mode on your Kubernetes cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Step 1 - Setup Dapr dev mode on your Kubernetes cluster
### Step 1 - Set up Dapr in dev mode on your Kubernetes cluster

tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved
tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved
tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved
tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved
The first thing you need is an RBAC enabled Kubernetes cluster. This could be running on your machine using Minikube, or it could be a fully-fledged cluster in Azure using [AKS](https://azure.microsoft.com/en-us/services/kubernetes-service/).

Once you have a cluster, follow the steps below to deploy Dapr to it. For more details, see [Deploy Dapr on a Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/).
## Using Dapr Mutli-app run
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add "Using Multi-app run" and "Using the kubectl CLI" into separate tabs to make this the whole tutorial shorter.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain this again?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think we can do that in GH

tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved

This spins down the Kubernetes resources that were deployed in the previous step.

## Using the `kubectl` CLI
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a tab here, to make this tutorial shorter. Can then either use Multi-app run or kubectl

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding tabs is possible in Hugo which we use for docs, is it possible in normal Github Readme?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's not something we can do in GH

tutorials/hello-kubernetes/README.md Outdated Show resolved Hide resolved
@msfussell
Copy link
Member

Also see this issue dapr/cli#1351 that need to be looked into

Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>
Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>
@mukundansundar mukundansundar changed the base branch from master to release-1.12 October 3, 2023 14:40
@mukundansundar mukundansundar marked this pull request as ready for review October 3, 2023 14:41
Copy link
Contributor

@greenie-msft greenie-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@paulyuk paulyuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@paulyuk paulyuk merged commit 2157c0c into dapr:release-1.12 Oct 3, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Multi-App Run for Kubernetes to the Hello Kubernetes Tutorial
4 participants