|
1 | 1 | // Copyright 2024 Canonical Ltd. |
2 | 2 | // Licensed under the AGPLv3, see LICENCE file for details. |
3 | 3 |
|
4 | | -// Package azure implements the Azure provider, registered with |
5 | | -// environs under the name "azure". The provider implements the |
6 | | -// [github.com/juju/juju/environs.Environ] interface, which defines |
| 4 | +// Package azure implements the Azure provider, registered with the |
| 5 | +// environs registry under the name "azure". The provider implements |
| 6 | +// the [github.com/juju/juju/environs.Environ] interface, which defines |
7 | 7 | // methods for provisioning compute, network, and storage resources. |
8 | 8 | // |
9 | 9 | // Here we describe some key implementation details specific to the Azure provider. |
|
12 | 12 | // |
13 | 13 | // The provider implementation is built using the [Azure SDK]. |
14 | 14 | // |
15 | | -// # Credential Types |
16 | | -// |
17 | | -// The supported credential types are: |
18 | | -// - service-principal-secret |
19 | | -// - managed-identity |
20 | | -// |
21 | | -// The recommended way to create a credential with which to bootstrap is |
22 | | -// to run |
23 | | -// |
24 | | -// juju add-credential azure |
25 | | -// |
26 | | -// and follow the prompts. Choosing "interactive" is the best choice for |
27 | | -// setting up a service principal credential as the browser is used to |
28 | | -// log into an Azure account and the credential attributes are filled |
29 | | -// in automatically. |
30 | | -// |
31 | | -// # Resource Groups |
| 15 | +// # Models |
32 | 16 | // |
33 | 17 | // All models, including the controller model, are created in a resource group. |
34 | 18 | // The resource group contains all artefacts for the model, including: |
|
47 | 31 | // After bootstrap, API clients are created for particular resource types defined in the SDK. |
48 | 32 | // All API clients use the same options which define the retry and logging behaviour. |
49 | 33 | // |
50 | | -// # Availability Sets |
| 34 | +// # Resiliency |
51 | 35 | // |
52 | | -// Each application has created for it an [Azure Availability Set] named after the application. |
| 36 | +// Unlike most other providers, the Azure provider does not currently support availability zones. |
| 37 | +// Instead, each application has created for it an [Azure Availability Set] named after the application. |
| 38 | +// Availability sets are scoped to a single Azure region. They are designed to protect against failures |
| 39 | +// within that region but do not provide protection against a regional outage |
53 | 40 | // |
54 | 41 | // # Machine Addresses |
55 | 42 | // |
|
0 commit comments