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

Azure IAM docs & tutorials #206

Merged
merged 25 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e59ad19
Add azure IAM code samples
amitlicht Mar 7, 2024
23e43c2
Read account & container name from env
amitlicht Mar 7, 2024
462e537
rename storage account
amitlicht Mar 7, 2024
6d0fea0
Prettify output
amitlicht Mar 7, 2024
08575df
Merge remote-tracking branch 'origin/main' into amitlicht/azure_iam_t…
amitlicht Mar 10, 2024
0d10327
Azure IAM tutorial - WIP
amitlicht Mar 10, 2024
a8c377f
Update reference
amitlicht Mar 10, 2024
6a2e9c9
Fixes
amitlicht Mar 10, 2024
4cd99ee
Add icons
amitlicht Mar 10, 2024
1cd9f27
Remove patch deployment
amitlicht Mar 10, 2024
5fcc229
Remove subscription ID & resource group from clientintents (auto-dete…
amitlicht Mar 10, 2024
3b6114d
Touchups
amitlicht Mar 10, 2024
450750f
Added new lines
tomergreenwald Mar 10, 2024
b40c1b5
let az cli figure out storage account SKU on its own
amitlicht Mar 10, 2024
856696e
Fix linebreak
amitlicht Mar 10, 2024
e2a76c0
Improving client app
amitlicht Mar 10, 2024
5249586
Improving client app
amitlicht Mar 10, 2024
ebf6619
More touchups
amitlicht Mar 10, 2024
0a2eed2
Document the label
amitlicht Mar 10, 2024
c60dd19
Update docs/features/azure-iam/tutorials/azure-iam-aks.mdx
amitlicht Mar 11, 2024
d541f94
Update docs/features/azure-iam/tutorials/azure-iam-aks.mdx
amitlicht Mar 11, 2024
4d59d80
Remove subscription & resource group from intents format
amitlicht Mar 11, 2024
0c08fc6
Fix the tutorial to work with custom storage accounts without modifyi…
amitlicht Mar 12, 2024
0c6485f
Merge branch 'amitlicht/azure_iam_tutorial' of github.com:otterize/do…
amitlicht Mar 12, 2024
64e19ff
Add an early-access note to Azure IAM
amitlicht Mar 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/features/azure-iam/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Azure IAM",
"position": 2,
"collapsed": true,
"customProps": {
"image": "/img/icons/azure.png"
}
}
68 changes: 68 additions & 0 deletions docs/features/azure-iam/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
sidebar_position: 1
title: Azure IAM | Overview
hide_table_of_contents: true
hide_title: true
---

import DocsLinkCard from "@site/src/components/LinkCard";

export const tutorials = [
{
title: 'Automate Azure IAM for AKS',
description: 'Create just-in-time Azure workload identities & role assignments that are kept in sync with your workloads',
url: '/features/azure-iam/tutorials/azure-iam-aks'
},
];


# Azure IAM

:::info
Azure IAM support is currently a part of our early access program.
Sign up to the [Early Access Beta Program](https://otterize.com/EarlyAccessBetaProgram) and we'll be in touch!
:::


Otterize can create just-in-time Azure IAM workload identities & role assignments for your workloads running on AKS Kubernetes clusters, greatly simplifying the lifecycle of managing Azure IAM identities and roles.

### Tutorials

To learn how to use the Intents Operator and Credentials Operator to manage just-in-time Azure IAM access, check out the tutorial.
<DocsLinkCard items={tutorials} colSize={"sm"}/>


### How does Otterize work with Azure IAM?

1. First, the AKS cluster must have [Otterize installed](/overview/installation), as well as the Otterize Azure integration configured.
2. To have a workload identity created for a pod, label the pod with `credentials-operator.otterize.com/create-azure-workload-identity: "true"`
3. The credentials operator will create an Azure workload identity and federated identity credential bound to the pod's ServiceAccount. The ServiceAccount will be annotated automatically.
4. At this point, the pod is able to assume the identity, but it does not have the permissions to perform any actions.
We will need to create a ClientIntents YAML for the access the service requires and apply it to our cluster.
Below is an example of a ClientIntents file for accessing an Azure Storage Blobs bucket.
View the [reference](/features/azure-iam/reference) to learn more about the Azure IAM ClientIntents syntax.
5. Once the intent is applied, the intents operator will create a new role assignment, which will be attached to the workload identity with the appropriate access.
6. Done!

```yaml
apiVersion: k8s.otterize.com/v1alpha3
kind: ClientIntents
metadata:
name: client
namespace: otterize-tutorial-azure-iam
spec:
service:
name: client
calls:
- name: "/providers/Microsoft.Storage/storageAccounts/otterizetutorialazureiam/blobServices/default/containers/test"
type: azure
azureRoles:
- "Storage Blob Data Contributor"
```

### Automatically generating ClientIntents for Azure IAM

Figuring out which access you need for Azure can be a painful, trial and error process, and something you _must_ do if you're tightening production access.

Otterize is getting ready to release support for using existing traffic to generate least-privilege Azure IAM policies. Keen to try this out as part of early access? Sign up to the [Early Access Beta Program](https://otterize.com/EarlyAccessBetaProgram) and we'll be in touch!

43 changes: 43 additions & 0 deletions docs/features/azure-iam/reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 3
title: Reference
---

### ClientIntents example (YAML)

```yaml
apiVersion: k8s.otterize.com/v1alpha3
kind: ClientIntents
metadata:
# The name of the pod that will be granted access
name: client
spec:
service:
name: client
calls:
# The Azure resource ID that references the resource(s) for the authorization. Subscription & resource group are automatically appended.
- name: "/providers/Microsoft.Storage/storageAccounts/otterizeazureiamtutorial/blobServices/default/containers/otterizeazureiamtutorialcontainer"
type: azure
# one or more Azure roles that will be provided to the specified resources
azureRoles:
- "Storage Blob Data Contributor"
```

### Annotations

| Key | Description | Default |
|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `credentials-operator.otterize.com/create-azure-workload-identity` | By setting to **true** the credential operator will create an Azure workload identity the associated pod | `false` |


### Helm Chart options

| Key | Description | Default |
|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `global.azure.enabled` | Enable or disable Azure integration | `false` |
| `azure.userAssignedIdentityID` | ID of the user assigned identity used by the operator to access Azure. | `(none)` |
| `azure.subscriptionID` | ID of the Azure subscription in which the AKS cluster is deployed. | `(none)` |
| `azure.resoureceGroup` | Name of the Azure resource group in which the AKS cluster is deployed. | `(none)` |
| `azure.aksClusterName` | Name of the AKS cluster in which the operator is deployed. | `(none)` |

View the [Helm chart reference](/reference/configuration/otterize-chart) for all other options
5 changes: 5 additions & 0 deletions docs/features/azure-iam/tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Tutorials",
"position": 2,
"collapsed": false
}
Loading
Loading