Skip to content

Commit

Permalink
fix: Readme regen & dummy change to enable publishing (#4025)
Browse files Browse the repository at this point in the history
## Description

- The previously merged PR had an outdated readme following another PR
that was merged in the meantime that required an update of the same
- Updated the readme + added a dummy change to trigger a publish

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.azd.aks-automatic-cluster](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.azd.aks-automatic-cluster.yml/badge.svg?event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.azd.aks-automatic-cluster.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [x] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation
  • Loading branch information
AlexanderSehr authored Dec 19, 2024
1 parent f5ccc71 commit 097e699
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
15 changes: 13 additions & 2 deletions avm/ptn/azd/aks-automatic-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ param location = '<location>'

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`aadProfile`](#parameter-aadprofile) | object | Enable Azure Active Directory integration. |
| [`aadProfile`](#parameter-aadprofile) | object | Settigs for the Azure Active Directory integration. |
| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
| [`location`](#parameter-location) | string | The Azure region/location for the AKS resources. |

Expand All @@ -136,13 +136,15 @@ The name for the AKS managed cluster.

- Required: Yes
- Type: string
- Nullable: No

### Parameter: `aadProfile`

Enable Azure Active Directory integration.
Settigs for the Azure Active Directory integration.

- Required: No
- Type: object
- Nullable: Yes

**Required parameters**

Expand All @@ -167,55 +169,63 @@ Specifies whether to enable Azure RBAC for Kubernetes authorization.

- Required: Yes
- Type: bool
- Nullable: No

### Parameter: `aadProfile.aadProfileManaged`

Specifies whether to enable managed AAD integration.

- Required: Yes
- Type: bool
- Nullable: No

### Parameter: `aadProfile.aadProfileAdminGroupObjectIDs`

Specifies the AAD group object IDs that will have admin role of the cluster.

- Required: No
- Type: array
- Nullable: Yes

### Parameter: `aadProfile.aadProfileClientAppID`

The client AAD application ID.

- Required: No
- Type: string
- Nullable: Yes

### Parameter: `aadProfile.aadProfileServerAppID`

The server AAD application ID.

- Required: No
- Type: string
- Nullable: Yes

### Parameter: `aadProfile.aadProfileServerAppSecret`

The server AAD application secret.

- Required: No
- Type: string
- Nullable: Yes

### Parameter: `aadProfile.aadProfileTenantId`

Specifies the tenant ID of the Azure Active Directory used by the AKS cluster for authentication.

- Required: No
- Type: string
- Nullable: Yes

### Parameter: `enableTelemetry`

Enable/Disable usage telemetry for module.

- Required: No
- Type: bool
- Nullable: No
- Default: `True`

### Parameter: `location`
Expand All @@ -224,6 +234,7 @@ The Azure region/location for the AKS resources.

- Required: No
- Type: string
- Nullable: No
- Default: `[resourceGroup().location]`

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion avm/ptn/azd/aks-automatic-cluster/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ param location string = resourceGroup().location
param enableTelemetry bool = true

import { aadProfileType } from 'br/public:avm/res/container-service/managed-cluster:0.5.3'
@description('Optional. Enable Azure Active Directory integration.')
@description('Optional. Settigs for the Azure Active Directory integration.')
param aadProfile aadProfileType?

// ============== //
Expand Down
4 changes: 2 additions & 2 deletions avm/ptn/azd/aks-automatic-cluster/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "8684475244832615377"
"templateHash": "1131028867773380264"
},
"name": "Azd AKS Automatic Cluster",
"description": "Creates an Azure Kubernetes Service (AKS) cluster with a system agent pool.\n\n**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case",
Expand Down Expand Up @@ -100,7 +100,7 @@
"$ref": "#/definitions/aadProfileType",
"nullable": true,
"metadata": {
"description": "Optional. Enable Azure Active Directory integration."
"description": "Optional. Settigs for the Azure Active Directory integration."
}
}
},
Expand Down

0 comments on commit 097e699

Please sign in to comment.