Skip to content

Commit 4dde368

Browse files
justaugustusk8s-ci-robot
justaugustus
authored and
k8s-ci-robot
committed
apis: Update types descriptions (#134)
Signed-off-by: Stephen Augustus <[email protected]>
1 parent ac592b8 commit 4dde368

6 files changed

+110
-105
lines changed

‎config/crds/azureprovider_v1alpha1_azureclusterproviderspec.yaml‎

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
2121
type: string
2222
caKeyPair:
23-
description: CAKeyPair is the key pair for ca certs.
23+
description: CAKeyPair is the key pair for CA certs.
2424
properties:
2525
cert:
2626
description: base64 encoded cert and key
@@ -343,7 +343,7 @@ spec:
343343
- key
344344
type: object
345345
frontProxyCAKeyPair:
346-
description: FrontProxyCAKeyPair is the key pair for FrontProxyKeyPair.
346+
description: FrontProxyCAKeyPair is the key pair for the front proxy.
347347
properties:
348348
cert:
349349
description: base64 encoded cert and key
@@ -365,6 +365,101 @@ spec:
365365
type: string
366366
metadata:
367367
type: object
368+
networkSpec:
369+
description: NetworkSpec encapsulates all things related to Azure network.
370+
properties:
371+
subnets:
372+
description: Subnets configuration.
373+
items:
374+
properties:
375+
cidrBlock:
376+
description: CidrBlock is the CIDR block to be used when the provider
377+
creates a managed Vnet.
378+
type: string
379+
id:
380+
description: ID defines a unique identifier to reference this
381+
resource.
382+
type: string
383+
name:
384+
description: Name defines a name for the subnet resource.
385+
type: string
386+
securityGroup:
387+
description: SecurityGroup defines the NSG (network security group)
388+
that should be attached to this subnet.
389+
properties:
390+
id:
391+
type: string
392+
ingressRule:
393+
items:
394+
properties:
395+
description:
396+
type: string
397+
destination:
398+
description: Destination - The destination address prefix.
399+
CIDR or destination IP range. Asterix '*' can also
400+
be used to match all source IPs. Default tags such
401+
as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet'
402+
can also be used.
403+
type: string
404+
destinationPorts:
405+
description: DestinationPorts - The destination port
406+
or range. Integer or range between 0 and 65535. Asterix
407+
'*' can also be used to match all ports.
408+
type: string
409+
protocol:
410+
type: string
411+
source:
412+
description: Source - The CIDR or source IP range. Asterix
413+
'*' can also be used to match all source IPs. Default
414+
tags such as 'VirtualNetwork', 'AzureLoadBalancer'
415+
and 'Internet' can also be used. If this is an ingress
416+
rule, specifies where network traffic originates from.
417+
type: string
418+
sourcePorts:
419+
description: SourcePorts - The source port or range.
420+
Integer or range between 0 and 65535. Asterix '*'
421+
can also be used to match all ports.
422+
type: string
423+
required:
424+
- description
425+
- protocol
426+
type: object
427+
type: array
428+
name:
429+
type: string
430+
required:
431+
- id
432+
- name
433+
- ingressRule
434+
type: object
435+
vnetId:
436+
description: VnetID defines the ID of the virtual network this
437+
subnet should be built in.
438+
type: string
439+
required:
440+
- name
441+
- vnetId
442+
- securityGroup
443+
type: object
444+
type: array
445+
vpc:
446+
description: Vnet configuration.
447+
properties:
448+
cidrBlock:
449+
description: CidrBlock is the CIDR block to be used when the provider
450+
creates a managed virtual network.
451+
type: string
452+
id:
453+
description: ID is the identifier of the virtual network this provider
454+
should use to create resources.
455+
type: string
456+
name:
457+
description: Name defines a name for the virtual network resource.
458+
type: string
459+
required:
460+
- name
461+
type: object
462+
type: object
368463
resourceGroup:
369464
type: string
370465
saKeyPair:

‎config/crds/azureprovider_v1alpha1_azureclusterproviderstatus.yaml‎

Lines changed: 0 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,6 @@ spec:
6565
type: object
6666
startupScript:
6767
type: string
68-
tags:
69-
type: object
7068
vmSize:
7169
description: Hardware profile
7270
type: string
@@ -114,98 +112,11 @@ spec:
114112
type: string
115113
sku:
116114
type: string
117-
tags:
118-
type: object
119115
type: object
120116
securityGroups:
121117
description: SecurityGroups is a map from the role/kind of the security
122118
group to its unique name, if any.
123119
type: object
124-
subnets:
125-
description: 'TODO: Move into NetworkSpec Subnets includes all the subnets
126-
defined inside the Vnet.'
127-
items:
128-
properties:
129-
cidrBlock:
130-
type: string
131-
id:
132-
type: string
133-
name:
134-
type: string
135-
securityGroup:
136-
properties:
137-
id:
138-
type: string
139-
ingressRule:
140-
items:
141-
properties:
142-
description:
143-
type: string
144-
destination:
145-
description: Destination - The destination address prefix.
146-
CIDR or destination IP range. Asterix '*' can also
147-
be used to match all source IPs. Default tags such
148-
as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet'
149-
can also be used.
150-
type: string
151-
destinationPorts:
152-
description: DestinationPorts - The destination port
153-
or range. Integer or range between 0 and 65535. Asterix
154-
'*' can also be used to match all ports.
155-
type: string
156-
protocol:
157-
type: string
158-
source:
159-
description: Source - The CIDR or source IP range. Asterix
160-
'*' can also be used to match all source IPs. Default
161-
tags such as 'VirtualNetwork', 'AzureLoadBalancer'
162-
and 'Internet' can also be used. If this is an ingress
163-
rule, specifies where network traffic originates from.
164-
type: string
165-
sourcePorts:
166-
description: SourcePorts - The source port or range.
167-
Integer or range between 0 and 65535. Asterix '*'
168-
can also be used to match all ports.
169-
type: string
170-
required:
171-
- description
172-
- protocol
173-
type: object
174-
type: array
175-
name:
176-
type: string
177-
tags:
178-
type: object
179-
required:
180-
- id
181-
- name
182-
- ingressRule
183-
- tags
184-
type: object
185-
vnetId:
186-
type: string
187-
required:
188-
- name
189-
- vnetId
190-
- cidrBlock
191-
- securityGroup
192-
type: object
193-
type: array
194-
vnet:
195-
description: Vnet defines the cluster vnet.
196-
properties:
197-
cidrBlock:
198-
type: string
199-
id:
200-
type: string
201-
name:
202-
type: string
203-
tags:
204-
type: object
205-
required:
206-
- cidrBlock
207-
- tags
208-
type: object
209120
type: object
210121
version: v1alpha1
211122
status:

‎config/crds/azureprovider_v1alpha1_azuremachineproviderstatus.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ spec:
6464
metadata:
6565
type: object
6666
vmId:
67-
description: VMID is the vm ID of the machine created in Azure
67+
description: VMID is the ID of the virtual machine created in Azure.
6868
type: string
6969
vmState:
70-
description: VMState is the state of the Azure vm for this machine
70+
description: VMState is the provisioning state of the Azure virtual machine.
7171
type: string
7272
version: v1alpha1
7373
status:

‎pkg/apis/azureprovider/v1alpha1/azureclusterproviderconfig_types.go‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
// +genclient
2525
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
2626

27-
// AzureClusterProviderSpec is the providerConfig for Azure in the cluster
27+
// AzureClusterProviderSpec is the providerConfig for Azure in the cluster.
2828
// +k8s:openapi-gen=true
2929
type AzureClusterProviderSpec struct {
3030
metav1.TypeMeta `json:",inline"`
@@ -36,13 +36,13 @@ type AzureClusterProviderSpec struct {
3636
ResourceGroup string `json:"resourceGroup"`
3737
Location string `json:"location"`
3838

39-
// CAKeyPair is the key pair for ca certs.
39+
// CAKeyPair is the key pair for CA certs.
4040
CAKeyPair KeyPair `json:"caKeyPair,omitempty"`
4141

4242
// EtcdCAKeyPair is the key pair for etcd.
4343
EtcdCAKeyPair KeyPair `json:"etcdCAKeyPair,omitempty"`
4444

45-
// FrontProxyCAKeyPair is the key pair for FrontProxyKeyPair.
45+
// FrontProxyCAKeyPair is the key pair for the front proxy.
4646
FrontProxyCAKeyPair KeyPair `json:"frontProxyCAKeyPair,omitempty"`
4747

4848
// SAKeyPair is the service account key pair.
@@ -82,32 +82,31 @@ type NetworkSpec struct {
8282
Subnets Subnets `json:"subnets,omitempty"`
8383
}
8484

85-
// VnetSpec configures an Azure Vnet.
85+
// VnetSpec configures an Azure virtual network.
8686
type VnetSpec struct {
87-
// ID is the vpc-id of the Vnet this provider should use to create resources.
87+
// ID is the identifier of the virtual network this provider should use to create resources.
8888
ID string `json:"id,omitempty"`
8989

9090
// Name defines a name for the virtual network resource.
9191
Name string `json:"name"`
9292

93-
// CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.
94-
// Defaults to 10.0.0.0/16.
93+
// CidrBlock is the CIDR block to be used when the provider creates a managed virtual network.
9594
CidrBlock string `json:"cidrBlock,omitempty"`
9695

9796
// Tags is a collection of tags describing the resource.
9897
// TODO: Uncomment once tagging is implemented.
9998
//Tags tags.Map `json:"tags,omitempty"`
10099
}
101100

102-
// IsProvided returns true if the Vnet is unmanaged.
101+
// IsProvided returns true if the virtual network is not managed by Cluster API.
103102
// TODO: Uncomment once tagging is implemented.
104103
/*
105104
func (v *VnetSpec) IsProvided() bool {
106105
return v.ID != "" && !v.Tags.HasManaged()
107106
}
108107
*/
109108

110-
// SubnetSpec configures an Azure Subnet.
109+
// SubnetSpec configures an Azure subnet.
111110
type SubnetSpec struct {
112111
// ID defines a unique identifier to reference this resource.
113112
ID string `json:"id,omitempty"`

‎pkg/apis/azureprovider/v1alpha1/azuremachineproviderconfig_types.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ type AzureMachineProviderSpec struct {
4343
SSHPrivateKey string `json:"sshPrivateKey"`
4444
}
4545

46-
// KubeadmConfiguration holds the various configurations that kubeadm uses
46+
// KubeadmConfiguration holds the various configurations that kubeadm uses.
4747
type KubeadmConfiguration struct {
4848
// JoinConfiguration is used to customize any kubeadm join configuration
4949
// parameters.

‎pkg/apis/azureprovider/v1alpha1/azuremachineproviderstatus_types.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ import (
2929
type AzureMachineProviderStatus struct {
3030
metav1.TypeMeta `json:",inline"`
3131
metav1.ObjectMeta `json:"metadata,omitempty"`
32-
// VMID is the vm ID of the machine created in Azure
32+
// VMID is the ID of the virtual machine created in Azure.
3333
// +optional
3434
VMID *string `json:"vmId,omitempty"`
3535

36-
// VMState is the state of the Azure vm for this machine
36+
// VMState is the provisioning state of the Azure virtual machine.
3737
// +optional
3838
VMState *VMState `json:"vmState,omitempty"`
3939

0 commit comments

Comments
 (0)