|
3 | 3 |
|
4 | 4 | :_mod-docs-content-type: CONCEPT |
5 | 5 | [id="installing-azure-user-defined-tags_{context}"] |
6 | | -= Configuring user-defined tags for Azure |
| 6 | += Configuring user-defined tags for {azure-short} |
7 | 7 |
|
8 | | -In {product-title}, you can use the tags for grouping resources and for managing resource access and cost. You can define the tags on the Azure resources in the `install-config.yaml` file only during {product-title} cluster creation. You cannot modify the user-defined tags after cluster creation. |
| 8 | +In {product-title}, you can use tags for grouping resources and for managing resource access and cost. Tags are applied only to the resources created by the {product-title} installation program and its core Operators such as Machine API Operator, Cluster Ingress Operator, Cluster Image Registry Operator. The {product-title} consists of the following types of tags: |
9 | 9 |
|
10 | | -Support for user-defined tags is available only for the resources created in the Azure Public Cloud. User-defined tags are not supported for the {product-title} clusters upgraded to {product-title} {product-version}. |
| 10 | +{product-title} tags:: By default, {product-title} installation program attaches the {product-title} tags to the {azure-short} resources. These {product-title} tags are not accessible to the users. The format of the {product-title} tags is `kubernetes.io_cluster.<cluster_id>:owned`, where `<cluster_id>` is the value of `.status.infrastructureName` in the infrastructure resource for the cluster. |
11 | 11 |
|
12 | | -User-defined and {product-title} specific tags are applied only to the resources created by the {product-title} installer and its core operators such as Machine api provider azure Operator, Cluster Ingress Operator, Cluster Image Registry Operator. |
| 12 | +User-defined tags:: User-defined tags are manually created in `install-config.yaml` file during installation. When creating the user-defined tags, you must consider the following points: |
13 | 13 |
|
14 | | -By default, {product-title} installer attaches the {product-title} tags to the Azure resources. These {product-title} tags are not accessible for the users. |
| 14 | +** User-defined tags on {azure-short} resources can only be defined during {product-title} cluster creation, and cannot be modified after the cluster is created. |
15 | 15 |
|
16 | | -You can use the `.platform.azure.userTags` field in the `install-config.yaml` file to define the list of user-defined tags as shown in the following `install-config.yaml` file. |
| 16 | +** Support for user-defined tags is available only for the resources created in the {azure-short} Public Cloud. |
17 | 17 |
|
18 | | -.Sample `install-config.yaml` file |
19 | | -[source,yaml] |
20 | | ----- |
21 | | -additionalTrustBundlePolicy: Proxyonly <1> |
22 | | -apiVersion: v1 |
23 | | -baseDomain: catchall.azure.devcluster.openshift.com <2> |
24 | | -compute: <3> |
25 | | -- architecture: amd64 |
26 | | - hyperthreading: Enabled <4> |
27 | | - name: worker |
28 | | - platform: {} |
29 | | - replicas: 3 |
30 | | -controlPlane: <5> |
31 | | - architecture: amd64 |
32 | | - hyperthreading: Enabled <6> |
33 | | - name: master |
34 | | - platform: {} |
35 | | - replicas: 3 |
36 | | -metadata: |
37 | | - creationTimestamp: null |
38 | | - name: user <7> |
39 | | -networking: |
40 | | - clusterNetwork: |
41 | | - - cidr: 10.128.0.0/14 |
42 | | - hostPrefix: 23 |
43 | | - machineNetwork: |
44 | | - - cidr: 10.0.0.0/16 |
45 | | - networkType: OVNKubernetes <8> |
46 | | - serviceNetwork: |
47 | | - - 172.30.0.0/16 |
48 | | -platform: |
49 | | - azure: |
50 | | - baseDomainResourceGroupName: os4-common <9> |
51 | | - cloudName: AzurePublicCloud <10> |
52 | | - outboundType: Loadbalancer |
53 | | - region: southindia <11> |
54 | | - userTags: <12> |
55 | | - createdBy: user |
56 | | - environment: dev |
57 | | ----- |
58 | | -<1> Defines the trust bundle policy. |
59 | | -<2> Required. The `baseDomain` parameter specifies the base domain of your cloud provider. The installation program prompts you for this value. |
60 | | -<3> The configuration for the machines that comprise compute. The `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`. If you do not provide these parameters and values, the installation program provides the default value. |
61 | | -<4> To enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. |
62 | | -<5> The configuration for the machines that comprise the control plane. The `controlPlane` section is a single mapping. The first line of the `controlPlane` section must not begin with a hyphen, `-`. You can use only one control plane pool. If you do not provide these parameters and values, the installation program provides the default value. |
63 | | -<6> To enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. |
64 | | -<7> The installation program prompts you for this value. |
65 | | -<8> The cluster network plugin to install. The default value `OVNKubernetes` is the only supported value. |
66 | | -<9> Specifies the resource group for the base domain of the Azure DNS zone. |
67 | | -<10> Specifies the name of the Azure cloud environment. You can use the `cloudName` field to configure the Azure SDK with the Azure API endpoints. If you do not provide value, the default value is Azure Public Cloud. |
68 | | -<11> Required. Specifies the name of the Azure region that hosts your cluster. The installation program prompts you for this value. |
69 | | -<12> Defines the additional keys and values that the installation program adds as tags to all Azure resources that it creates. |
70 | | - |
71 | | -The user-defined tags have the following limitations: |
72 | | - |
73 | | -* A tag key can have a maximum of 128 characters. |
74 | | -* A tag key must begin with a letter, end with a letter, number or underscore, and can contain only letters, numbers, underscores, periods, and hyphens. |
75 | | -* Tag keys are case-insensitive. |
76 | | -* Tag keys cannot be `name`. It cannot have prefixes such as `kubernetes.io`, `openshift.io`, `microsoft`, `azure`, and `windows`. |
77 | | -* A tag value can have a maximum of 256 characters. |
78 | | -* You can configure a maximum of 10 tags for resource group and resources. |
79 | | -
|
80 | | -For more information about Azure tags, see link:https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources?tabs=json[Azure user-defined tags] |
| 18 | +** User-defined tags are not supported for the {product-title} clusters upgraded to {product-title} {product-version}. |
0 commit comments