-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #409 from cprivitere/cprivitere/issue401
📖 Document usage of hardware reservations
- Loading branch information
Showing
3 changed files
with
41 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,77 +1,30 @@ | ||
# PacketMachine CRD | ||
|
||
PacketMachine is the name of the resource that identifies a | ||
[Device](equinixMetalDeviceAPI) on Packet. | ||
[Device](https://metal.equinix.com/developers/api/devices/#devices-createdevice) on Packet. | ||
|
||
This is an example of it: | ||
|
||
```yaml | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3 | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
kind: PacketMachine | ||
metadata: | ||
name: "qa-controlplane-0" | ||
spec: | ||
OS: "ubuntu_18_04" | ||
os: "ubuntu_18_04" | ||
billingCycle: hourly | ||
machineType: "t2.small" | ||
machineType: "c3.small.x86" | ||
sshKeys: | ||
- "your-sshkey-name" | ||
- "Your SSH public key" | ||
tags: [] | ||
``` | ||
|
||
It is a [Kubernetes Custom Resource Definition (CRD)](openapi-types) as everything | ||
It is a [Kubernetes Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) as everything | ||
else in the cluster-api land. | ||
|
||
The reported fields in the example are the most common one but you can see the | ||
full list of supported parameters as part of the OpenAPI definition available | ||
[here](../../config/crd/bases/infrastructure.cluster.x-k8s.io_packetclusters.yaml) | ||
searching for `kind: PacketMachine`. | ||
|
||
The `PacketMachine`, `PacketCluster`, and `PacketMachineTemplate` CRD specs are also documented at [docs.crds.dev](https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api-provider-packet). | ||
|
||
## Reserved instances | ||
|
||
Packet provides the possibility to [reserve | ||
hardware](equinix-metal-docs-reserved-hardware) in order to have to power you need | ||
always available. | ||
|
||
> Reserved hardware gives you the ability to reserve specific servers for a | ||
> committed period of time. Unlike hourly on-demand, once you reserve hardware, | ||
> you will have access to that specific hardware for the duration of the | ||
> reservation. | ||
You can specify the reservation ID using the field `hardwareReservationID`: | ||
|
||
```yaml | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3 | ||
kind: PacketMachine | ||
metadata: | ||
name: "qa-controlplane-0" | ||
spec: | ||
OS: "ubuntu_18_04" | ||
facility: | ||
- "dfw2" | ||
billingCycle: hourly | ||
machineType: "t2.small" | ||
sshKeys: | ||
- "your-sshkey-name" | ||
hardwareReservationID: "d3cb029a-c5e4-4e2b-bafc-56266639685f" | ||
tags: [] | ||
``` | ||
|
||
### pros and cons | ||
|
||
Hardware reservation is a great feature, this chapter is about the feature | ||
described above and nothing more. | ||
It covers a very simple use case, you have a set of machines that you created | ||
statically in the YAML and you like to have them using a reservation ID. | ||
|
||
It does not work in combination of PacketMachineTemplate and MachineDeployment | ||
where the pool of PacketMachine is dynamically managed by the cluster-api | ||
controllers. You can track progress on this scenario subscribing to the issue | ||
["Add support for reservation IDs with MachineDeployment #136"](github-issue-resid-dynamic) on GitHub. | ||
|
||
[equinixMetalDeviceAPI]: https://metal.equinix.com/developers/api/devices/#devices-createdevice | ||
[openapi-types]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/ | ||
[equinix-metal-docs-reserved-hardware]: https://metal.equinix.com/developers/docs/deploy/reserved/ | ||
[github-issue-resid-dynamic]: https://github.com/packethost/cluster-api-provider-packet/issues/136 | ||
The `PacketMachine`, `PacketCluster`, and `PacketMachineTemplate` CRD specs are also documented at [docs.crds.dev](https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api-provider-packet). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters