Skip to content

Commit

Permalink
Document the api changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Cole committed Sep 4, 2023
1 parent 65f44c6 commit 5b5d3cc
Showing 1 changed file with 56 additions and 11 deletions.
67 changes: 56 additions & 11 deletions website/content/en/preview/concepts/node-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,27 @@ kind: AWSNodeTemplate
metadata:
name: default
spec:
subnetSelector: { ... } # required, discovers tagged subnets to attach to instances
securityGroupSelector: { ... } # required, discovers tagged security groups to attach to instances
instanceProfile: "..." # optional, overrides the node's identity from global settings
amiFamily: "..." # optional, resolves a default ami and userdata
amiSelector: { ... } # optional, discovers tagged amis to override the amiFamily's default
userData: "..." # optional, overrides autogenerated userdata with a merge semantic
tags: { ... } # optional, propagates tags to underlying EC2 resources
metadataOptions: { ... } # optional, configures IMDS for the instance
blockDeviceMappings: [ ... ] # optional, configures storage devices for the instance
detailedMonitoring: "..." # optional, configures detailed monitoring for the instance
subnetSelector: { ... } # required, discovers tagged subnets to attach to instances
securityGroupSelector: { ... } # required, discovers tagged security groups to attach to instances
instanceProfile: "..." # optional, overrides the node's identity from global settings
amiFamily: "..." # optional, resolves a default ami and userdata
amiSelector: { ... } # optional, discovers tagged amis to override the amiFamily's default
userData: "..." # optional, overrides autogenerated userdata with a merge semantic
tags: { ... } # optional, propagates tags to underlying EC2 resources
metadataOptions: { ... } # optional, configures IMDS for the instance
blockDeviceMappings: [ ... ] # optional, configures storage devices for the instance
detailedMonitoring: "..." # optional, configures detailed monitoring for the instance
licenseSelector: { ... } #optional, discovers resource group license configurations
hostResourceGroupSelector: { ... } # optional, discovers resource groups to launch instances into
placementGroupSelector: { ... } # optional, discovers resource groups to launch instances into

status:
subnets: { ... } # resolved subnets
securityGroups: { ... } # resolved security groups
amis: { ... } # resolved AMIs
licenseConfigrations: { ... } # resolved licenseConfigurationSpecifications
hostResourceGroups: { ... } # resolved hostResourceGroups
placementGroups: { ... } # resolved ec2 placementGroups
```
Refer to the [Provisioner docs]({{<ref "./provisioners" >}}) for settings applicable to all providers. To explore various `AWSNodeTemplate` configurations, refer to the examples provided [in the Karpenter Github repository](https://github.com/aws/karpenter/blob/main/examples/provisioner/).

Expand Down Expand Up @@ -591,6 +598,32 @@ spec:
detailedMonitoring: true
```

## spec.licenseSelector
licenseSelector: { ... } #optional, discovers resource group license configurations
Example:
```
licenseSelector:
name: myLicense
tags:
key: value
```

## spec.hostResourceGroupSelector
```
hostResourceGroupSelector:
name: "r5-1"
```

## spec.placementGroupSelector
placementGroupSelector: { ... } # optional, discovers resource groups to launch instances into
```
placementGroupSelector:
name: placementGroup
tags:
key: value
```

## status.subnets
`status.subnets` contains the `id` and `zone` of the subnets utilized during node launch. The subnets are sorted by the available IP address count in decreasing order.

Expand Down Expand Up @@ -670,4 +703,16 @@ status:
values:
- aws
- nvidia
```
```

## status.licenseConfigurations

contains the arn's of the licenses used to launch instances

## status.hostResourceGroups

contains the arns of the host resource groups

## status.placementGroups

contains the arns of the ec2 placement groups

0 comments on commit 5b5d3cc

Please sign in to comment.