docs: add config documentation #155
Conversation
|
Hi @rothgar can you check this documentation. Thanks. |
docs/config.md
Outdated
| annotations: | ||
| ... | ||
| # Set annotations based on transformation rules | ||
| talos.dev/instance-id: "id-e8e8c388-5812-4db0-87e2-ad1fee51a1c1" |
There was a problem hiding this comment.
Should there also be an omni instance-id or will they be the same?
There was a problem hiding this comment.
this is just a key/value string, You can set everything that you want. In this example - talos.dev/instance-id: "id-{{ .InstanceID }}" there InstanceID - is cloud instance ID
There was a problem hiding this comment.
I think my main question is if this should be talos.dev/ or an omni identifier. Will the ID be the same in this label as it shows up in Omni?
There was a problem hiding this comment.
Oh i see, i renamed it, to not confuse people ;) custom-annotation/instance-id
| InstanceType string `yaml:"instanceType,omitempty" protobuf:"5"` | ||
| InstanceID string `yaml:"instanceId,omitempty" protobuf:"6"` | ||
| ProviderID string `yaml:"providerId,omitempty" protobuf:"7"` | ||
| Spot bool `yaml:"spot,omitempty" protobuf:"8"` |
There was a problem hiding this comment.
In AWS this is called "provisioning type" or "provisioning model" (GCP) and would be a string like spot, on-demand, or reserved.
There was a problem hiding this comment.
Spot, if true - can terminate at any time (cloud decision). on-demand and reserved - your decision
There was a problem hiding this comment.
Is the goal of this field to set the controller to do specific things with spot instances only?
There was a problem hiding this comment.
Do not deploy pods which cannot migrate fast (long task jobs for instance)
There was a problem hiding this comment.
If our goal is to help users not run jobs that cannot terminate quickly I think spot: true/false is to vague. There are other reasons they may want to target spot, on-demand, and reserved instance types. And not every cloud provider calls spare capacity "spot".
Karpenter uses the capacity-type label which I think would be a more generic way to present this information that works across different cloud environments.
There was a problem hiding this comment.
yep ~2 years ago, Karpenter was not so popular.
Make cense to rename it in future.
There was a problem hiding this comment.
OK, no problem. As long as we can change it it the future if we need to.
docs/config.md
Outdated
| annotations: | ||
| ... | ||
| # Set annotations based on transformation rules | ||
| talos.dev/instance-id: "id-e8e8c388-5812-4db0-87e2-ad1fee51a1c1" |
There was a problem hiding this comment.
this is just a key/value string, You can set everything that you want. In this example - talos.dev/instance-id: "id-{{ .InstanceID }}" there InstanceID - is cloud instance ID
| InstanceType string `yaml:"instanceType,omitempty" protobuf:"5"` | ||
| InstanceID string `yaml:"instanceId,omitempty" protobuf:"6"` | ||
| ProviderID string `yaml:"providerId,omitempty" protobuf:"7"` | ||
| Spot bool `yaml:"spot,omitempty" protobuf:"8"` |
There was a problem hiding this comment.
Spot, if true - can terminate at any time (cloud decision). on-demand and reserved - your decision
Update documentation. Signed-off-by: Serge Logvinov <[email protected]>
|
/m |
Update documentation.
Pull Request
What? (description)
Why? (reasoning)
Acceptance
Please use the following checklist:
make conformance)make lint)make unit)