Azure Permissons #2077

karl-cardenas-coding · 2024-01-18T23:02:12Z

Describe the Change

This PR adds a new documentation page to the Azure sections. A detailed list of the required permissions for static and dynamic placement use cases is now available.

Required Permissions Page (new)
The other affected pages have new clarification around what Disable Properties does.

Review Changes

💻 Preview URL

🎫 DOC-916
🎫 DOC-928
🎫 DOC-929
🎫 DOC-936

netlify · 2024-01-18T23:02:17Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`c1d1132`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/65ae8920e0c45e0008255f60
😎 Deploy Preview	https://deploy-preview-2077--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

mattwelke

LGTM

yuliiiah

Requesting changes because the structure is a bit inconsistent :)

docs/docs-content/clusters/public-cloud/azure/aks.md

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md

docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

yuliiiah · 2024-01-19T19:20:45Z

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

+
+## Dynamic Placement
+
+If you want to support dynamic placement use cases, ensure Palette has the following actions at the subscription level: 


To stay consistent with the previous section, this needs an explanation for when users should choose dynamic placement.

As you've described under static placement, that would be "when you have a pre-existing network resource group, VNet, subnets and security groups you want Palette to use when deploying a cluster". What is the use case here?

yuliiiah · 2024-01-19T19:23:22Z

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

+
+
+
+## Validator


This feels out of context here. Static and dynamic placement are types of management in Palette, and Validator is a tool. It might be the case that I don't understand the technical side of it, but purely from the structure perspective, I'd treat Validator as different from static and dynamic placement.

I wanted to jump in and add some context.

The Validator tool is something we created to, among other things out in the open source community, help customers deploy Palette. Its purpose within Spectro Cloud, with Azure, is to help our customers ensure that they've followed the instructions under Static Placement and Dynamic Placement correctly - that they've added the permissions required to use Palette. For Validator to work, it itself needs permissions. They're kind of "meta" permissions - permissions that allow a service principal to check permissions on other service principals.

You'e right that the act of using Validator is something completely different from the act of using Palette. We were trying to figure out the best place to tell our users which Azure permissions they need in order to use Validator when the reason they want to use it is because they plan to use Palette to deploy a cluster to Azure.

yuliiiah · 2024-01-19T19:25:11Z

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

+
+## Validator
+
+To use the [Validator](https://github.com/spectrocloud-labs/validator) with the [Azure plugin](https://github.com/spectrocloud-labs/validator-plugin-azure) you need the following actions to be able to ensure the roles attached to the service principal used by Validator have the required permissions:


When would be good cases for me to use the Validator? As you've described under static placement, that would be "when you have a pre-existing network resource group, VNet, subnets and security groups you want Palette to use when deploying a cluster". What is the use case here?

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

Co-authored-by: Yuliia Horbenko <[email protected]>

github-actions · 2024-01-19T20:14:23Z

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

+
+</details>
+
+Palette supports the following use cases for static placement: Single Cluster, Multiple Cluster – Same Resource Group, and Multiple Cluster – Same Subscription. Each use case requires the same actions but with different scope levels.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.EmDash] Don't put a space before or after a dash.

github-actions · 2024-01-19T20:14:23Z

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

+
+</details>
+
+Palette supports the following use cases for static placement: Single Cluster, Multiple Cluster – Same Resource Group, and Multiple Cluster – Same Subscription. Each use case requires the same actions but with different scope levels.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.EnDash] Use an em dash ('—') instead of '–'.

docs/docs-content/clusters/public-cloud/azure/required-permissions.md

github-actions · 2024-01-22T15:27:09Z

docs/docs-content/clusters/public-cloud/azure/aks.md

-:::info
-
-New worker pools may be added if you want to customize specific worker nodes to run specialized workloads. As an
+:::info New worker pools may be added if you want to customize specific worker nodes to run specialized workloads. As an


🚫 [vale] _{reported by reviewdog 🐶}
[spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.

vault-token-factory-spectrocloud · 2024-01-22T15:44:17Z

💔 All backports failed

Status	Branch	Result
❌	version-4-0	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-0: - docs: Provide missing Autocale information (#1857) DOC-897
❌	version-3-4	Backport failed because of merge conflicts You might need to backport the following PRs to version-3-4: - docs: Provide missing Autocale information (#1857) DOC-897 - Refactor/restructure cluster & app profiles sections (#1551) - docs: updated URLs to use file path context
❌	version-4-1	Backport failed because of merge conflicts
❌	version-4-2	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-2: - replace caution with warning (#2039)

Manual backport

To create the backport manually run:

backport --pr 2077

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

* docs: wip * docs: added table * docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929 * docs: DOC-936 * chore: update DOC-936 * vale: feedback * docs: feedback * docs: vale feedeback * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * save * docs: feedback * docs: azure callout change- * docs: fix * docs: changed order * Update docs/docs-content/clusters/public-cloud/azure/required-permissions.md Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback incorporated --------- Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077) * docs: wip * docs: added table * docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929 * docs: DOC-936 * chore: update DOC-936 * vale: feedback * docs: feedback * docs: vale feedeback * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * save * docs: feedback * docs: azure callout change- * docs: fix * docs: changed order * Update docs/docs-content/clusters/public-cloud/azure/required-permissions.md Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback incorporated --------- Co-authored-by: Yuliia Horbenko <[email protected]> * chore: fixed gitleaks --------- Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077) * docs: wip * docs: added table * docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929 * docs: DOC-936 * chore: update DOC-936 * vale: feedback * docs: feedback * docs: vale feedeback * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * save * docs: feedback * docs: azure callout change- * docs: fix * docs: changed order * Update docs/docs-content/clusters/public-cloud/azure/required-permissions.md Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback incorporated --------- Co-authored-by: Yuliia Horbenko <[email protected]> * chore: save * chore: fixed gitleaks false positives --------- Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077) * docs: wip * docs: added table * docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929 * docs: DOC-936 * chore: update DOC-936 * vale: feedback * docs: feedback * docs: vale feedeback * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * save * docs: feedback * docs: azure callout change- * docs: fix * docs: changed order * Update docs/docs-content/clusters/public-cloud/azure/required-permissions.md Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback incorporated --------- Co-authored-by: Yuliia Horbenko <[email protected]> * chore: fixed gitignore --------- Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077) * docs: wip * docs: added table * docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929 * docs: DOC-936 * chore: update DOC-936 * vale: feedback * docs: feedback * docs: vale feedeback * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * save * docs: feedback * docs: azure callout change- * docs: fix * docs: changed order * Update docs/docs-content/clusters/public-cloud/azure/required-permissions.md Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback incorporated --------- Co-authored-by: Yuliia Horbenko <[email protected]> * chore: missed a fille * chore: fixed false gitleaks --------- Co-authored-by: Yuliia Horbenko <[email protected]>

vault-token-factory-spectrocloud · 2024-04-05T22:48:15Z

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

vault-token-factory-spectrocloud · 2024-04-06T06:02:06Z

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

docs: wip

5fcc034

docs: added table

227d651

karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 labels Jan 19, 2024

karl-cardenas-coding added 2 commits January 19, 2024 08:38

docs: fixed broken anchor tag DOC-916 DOC-928 DOC-929

f1eb51b

docs: DOC-936

ab39a95

karl-cardenas-coding marked this pull request as ready for review January 19, 2024 17:10

karl-cardenas-coding requested a review from a team as a code owner January 19, 2024 17:10

karl-cardenas-coding requested review from addetz, lennessyy and caroldelwing January 19, 2024 17:10

github-actions bot reviewed Jan 19, 2024

View reviewed changes

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md Outdated Show resolved Hide resolved

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md Outdated Show resolved Hide resolved

karl-cardenas-coding added 2 commits January 19, 2024 10:11

chore: update DOC-936

5722343

vale: feedback

a380e96

github-actions bot reviewed Jan 19, 2024

View reviewed changes

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md Outdated Show resolved Hide resolved

docs/docs-content/clusters/public-cloud/azure/azure-cloud.md Outdated Show resolved Hide resolved

karl-cardenas-coding requested a review from mattwelke January 19, 2024 17:28

docs: feedback

ca938e9

github-actions bot reviewed Jan 19, 2024

View reviewed changes

docs/docs-content/clusters/public-cloud/azure/required-permissions.md Outdated Show resolved Hide resolved

mattwelke approved these changes Jan 19, 2024

View reviewed changes

docs: vale feedeback

daa24f3

mattwelke approved these changes Jan 19, 2024

View reviewed changes

Merge branch 'master' into azure-permissions-1-18

0dbe237

yuliiiah suggested changes Jan 19, 2024

View reviewed changes

karl-cardenas-coding and others added 2 commits January 19, 2024 13:13

Apply suggestions from code review

fa30212

Co-authored-by: Yuliia Horbenko <[email protected]>

save

7ccf2d3

github-actions bot reviewed Jan 19, 2024

View reviewed changes

karl-cardenas-coding added 2 commits January 22, 2024 07:41

docs: feedback incorporated

faf03cb

Merge branch 'master' into azure-permissions-1-18

c1d1132

github-actions bot reviewed Jan 22, 2024

View reviewed changes

karl-cardenas-coding merged commit 1e58a38 into master Jan 22, 2024
9 checks passed

karl-cardenas-coding deleted the azure-permissions-1-18 branch January 22, 2024 15:43

karl-cardenas-coding mentioned this pull request Jan 22, 2024

[version-4-2] backport/version 4 2/pr 2077 #2084

Merged

karl-cardenas-coding mentioned this pull request Jan 22, 2024

[version-4-1] docs: versionBackport/version 4 1/pr2077 #2085

Merged

karl-cardenas-coding mentioned this pull request Jan 22, 2024

[version-4-0] docs: versionBackport/version 4 0/pr2077 #2087

Merged

This was referenced Feb 22, 2024

chore: update pdf script #2268

Merged

docs: Update azure-cloud.md #2305

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Mar 14, 2024

Windows node pool #2130

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Mar 22, 2024

Image Conversion to webp #2439

Merged

2 tasks

vault-token-factory-spectrocloud bot added the released label Apr 5, 2024

vault-token-factory-spectrocloud bot mentioned this pull request May 7, 2024

docs: document Crossplane PAD-82 #2713

Merged

2 tasks

vault-token-factory-spectrocloud bot mentioned this pull request Jul 18, 2024

docs: refactor taints guide DOC-1272 #3395

Merged

2 tasks

vault-token-factory-spectrocloud bot mentioned this pull request Sep 24, 2024

Getting Started - Phase 2 #3159

Merged

2 tasks

This was referenced Oct 30, 2024

Azure Permissions Refactor #4272

Merged

Some small fixes for Azure v2 docs #4513

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Jan 9, 2025

DOC-887: SSH usernames #5091

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Azure Permissons #2077

Azure Permissons #2077

karl-cardenas-coding commented Jan 18, 2024 •

edited

Loading

netlify bot commented Jan 18, 2024 •

edited

Loading

mattwelke left a comment

yuliiiah left a comment

yuliiiah Jan 19, 2024

yuliiiah Jan 19, 2024

mattwelke Jan 19, 2024 •

edited

Loading

yuliiiah Jan 19, 2024

github-actions bot Jan 19, 2024

github-actions bot Jan 19, 2024

github-actions bot Jan 22, 2024

vault-token-factory-spectrocloud bot commented Jan 22, 2024

vault-token-factory-spectrocloud bot commented Apr 5, 2024

vault-token-factory-spectrocloud bot commented Apr 6, 2024


		## Dynamic Placement

		If you want to support dynamic placement use cases, ensure Palette has the following actions at the subscription level:


		## Validator

		To use the [Validator](https://github.com/spectrocloud-labs/validator) with the [Azure plugin](https://github.com/spectrocloud-labs/validator-plugin-azure) you need the following actions to be able to ensure the roles attached to the service principal used by Validator have the required permissions:


		</details>

		Palette supports the following use cases for static placement: Single Cluster, Multiple Cluster – Same Resource Group, and Multiple Cluster – Same Subscription. Each use case requires the same actions but with different scope levels.

Azure Permissons #2077

Azure Permissons #2077

Conversation

karl-cardenas-coding commented Jan 18, 2024 • edited Loading

Describe the Change

Review Changes

netlify bot commented Jan 18, 2024 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

mattwelke left a comment

Choose a reason for hiding this comment

yuliiiah left a comment

Choose a reason for hiding this comment

yuliiiah Jan 19, 2024

Choose a reason for hiding this comment

yuliiiah Jan 19, 2024

Choose a reason for hiding this comment

mattwelke Jan 19, 2024 • edited Loading

Choose a reason for hiding this comment

yuliiiah Jan 19, 2024

Choose a reason for hiding this comment

github-actions bot Jan 19, 2024

Choose a reason for hiding this comment

github-actions bot Jan 19, 2024

Choose a reason for hiding this comment

github-actions bot Jan 22, 2024

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Jan 22, 2024

💔 All backports failed

Manual backport

Questions ?

vault-token-factory-spectrocloud bot commented Apr 5, 2024

vault-token-factory-spectrocloud bot commented Apr 6, 2024

karl-cardenas-coding commented Jan 18, 2024 •

edited

Loading

netlify bot commented Jan 18, 2024 •

edited

Loading

mattwelke Jan 19, 2024 •

edited

Loading