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 "Deploy wasmCloud on AKS article" #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

protochron
Copy link

This PR adds a new article to the AKS documentation describing how to deploy wasmCloud on AKS.

@protochron
Copy link
Author

@Mossaka @squillace not sure of the right procedure for adding this article.

Copy link

Learn Build status updates of commit d3c2b7d:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/aks/openfaas.md ⚠️Warning Details
articles/aks/wasmcloud.md ⚠️Warning Details

articles/aks/openfaas.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Use OpenFaaS on Azure Kubernetes Service (AKS) - Azure Kubernetes Service' is duplicated in: 'articles/aks/openfaas.md(2,8), articles/aks/wasmcloud.md(2,8)'. Titles must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to deploy and use OpenFaaS on an Azure Kubernetes Service (AKS) cluster to build serverless functions with containers.' is duplicated in 'articles/aks/openfaas.md(3,14)', 'articles/aks/wasmcloud.md(3,14)'.

articles/aks/wasmcloud.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Use OpenFaaS on Azure Kubernetes Service (AKS) - Azure Kubernetes Service' is duplicated in: 'articles/aks/openfaas.md(2,8), articles/aks/wasmcloud.md(2,8)'. Titles must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to deploy and use OpenFaaS on an Azure Kubernetes Service (AKS) cluster to build serverless functions with containers.' is duplicated in 'articles/aks/openfaas.md(3,14)', 'articles/aks/wasmcloud.md(3,14)'.
  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'protochron' is not a valid Microsoft alias.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@protochron
Copy link
Author

@microsoft-github-policy-service agree

This PR adds a new article to the AKS documentation describing how to
deploy wasmCloud on AKS.
Copy link

Learn Build status updates of commit b766340:

💡 Validation status: suggestions

File Status Preview URL Details
articles/aks/wasmcloud.md 💡Suggestion Details

articles/aks/wasmcloud.md

  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'protochron' is not a valid Microsoft alias.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link

Learn Build status updates of commit f0cb834:

✅ Validation status: passed

File Status Preview URL Details
articles/aks/wasmcloud.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
File Change Percent This PR contains file(s) with more than 30% file change.

@Jak-MS
Copy link
Contributor

Jak-MS commented Nov 7, 2024

#assign: @Tysonn, @mkluck

Copy link
Contributor

The following users don't have valid GitHub IDs, or are not collaborators on this repo: tysonn, mkluck

@Jak-MS
Copy link
Contributor

Jak-MS commented Nov 7, 2024

@squillace - can you review this?

Note that all articles must be reviewed and owned by a Microsoft content professional... and the commits in this PR will have to move to the private repo for a full PR review after approval by a technical and content reviewer.

please tag me or MicrosoftDocs/public-repo-pr-review-team whenever you need a response from us. Thanks.

repo owners fyi: @Tysonn @mkluck

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@Mossaka
Copy link
Contributor

Mossaka commented Nov 7, 2024

I will review it too

@@ -0,0 +1,218 @@
---
title: Use wasmCloud on Azure Kubernetes Service (AKS)
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to be consistent with SpinKube article: https://learn.microsoft.com/en-us/azure/aks/deploy-spinkube

I would suggest the title to be "Deploy wasmCloud to Azure Kubernetes Service (AKS) to run distributed WebAssembly (Wasm) workloads"

ms.date: 11/07/2024
---

# Use wasmCloud on Azure Kubernetes Service (AKS)
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
# Use wasmCloud on Azure Kubernetes Service (AKS)
# Deploy wasmCloud to Azure Kubernetes Service (AKS) to run distributed WebAssembly (Wasm) workloads

---

# Use wasmCloud on Azure Kubernetes Service (AKS)

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a paragraph describing what WebAssembly Components are

# Use wasmCloud on Azure Kubernetes Service (AKS)

[wasmCloud][wasmcloud] is a CNCF project designed to fast-track the development, deployment and orchestration of WebAssembly components. This document details instructions on how to deploy wasmCloud on an Azure Kubernetes Service (AKS) cluster.

Copy link
Contributor

Choose a reason for hiding this comment

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

Describe what are the benefits of running WebAssembly workloads compare with container workloads

* You need an active Azure subscription. If you don't have one, create a [free account](https://azure.microsoft.com/free/) before you begin.
* You need an AKS cluster. If you don't have an existing cluster, you can create one using the [Azure CLI](./learn/quick-kubernetes-deploy-cli.md), [Azure PowerShell](./learn/quick-kubernetes-deploy-powershell.md), or [Azure portal](./learn/quick-kubernetes-deploy-portal.md).
* You need to install the wasmCloud CLI (wash). For installation options, see [wasmcloud-cli][wasmcloud-cli].

Copy link
Contributor

Choose a reason for hiding this comment

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

Specify the versions for tools like wash

* You need an active Azure subscription. If you don't have one, create a [free account](https://azure.microsoft.com/free/) before you begin.
* You need an AKS cluster. If you don't have an existing cluster, you can create one using the [Azure CLI](./learn/quick-kubernetes-deploy-cli.md), [Azure PowerShell](./learn/quick-kubernetes-deploy-powershell.md), or [Azure portal](./learn/quick-kubernetes-deploy-portal.md).
* You need to install the wasmCloud CLI (wash). For installation options, see [wasmcloud-cli][wasmcloud-cli].

Copy link
Contributor

Choose a reason for hiding this comment

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

Describe "## Limitations"

# By default, the chart installs NATS, Wadm, and wasmCloud Operator subcharts
helm upgrade --install \
wasmcloud-platform \
--values https://raw.githubusercontent.com/wasmCloud/wasmcloud/main/charts/wasmcloud-platform/values.yaml \
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider use a tagged version instead of "main"

```output
Hello from Rust!
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a section to clean up the resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants