Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Commit

Permalink
Merge pull request #1537 from kinvolk/imran/rename-packet-to-equinix-…
Browse files Browse the repository at this point in the history
…metal

Rename Packet to Equinix Metal in existing Documentation.
  • Loading branch information
ipochi authored Aug 4, 2021
2 parents 81f1a9c + 05ce568 commit 09579eb
Show file tree
Hide file tree
Showing 27 changed files with 152 additions and 155 deletions.
2 changes: 1 addition & 1 deletion docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ Kubernetes.
It focuses on being minimal, easy to use, and secure by default.

Lokomotive is fully self-hosted and includes [Lokomotive
Components](./concepts/components) adding essential functionality for production
Components](./concepts/components.md) adding essential functionality for production
not shipped with upstream Kubernetes.
2 changes: 1 addition & 1 deletion docs/concepts/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ There is ongoing [upstream](https://github.com/kubernetes/kubernetes/pull/91277)
## Flatcar Linux Customization
Flatcar Container Linux deployments on AWS can be customized with Container Linux Configs.
For more information, see [Flatcar Container Linux Customization](/docs/concepts/flatcar-container-linux.md#Customization).
For more information, see [Flatcar Container Linux Customization](./flatcar-container-linux.md#customization).
2 changes: 1 addition & 1 deletion docs/concepts/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Lokomotive also provides the [rook](../configuration-reference/components/rook.m
[rook-ceph](../configuration-reference/components/rook-ceph.md) components for using Rook as the storage
solution for Lokomotive cluster.

### Load Balancing/Ingress (for Packet platform only)
### Load Balancing/Ingress (for Equinix Metal platform only)

Lokomotive provides the [MetalLB](../configuration-reference/components/metallb.md) component for load
balancing in platforms without network load-balancers and
Expand Down
10 changes: 5 additions & 5 deletions docs/concepts/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DNS records on your behalf.

### [AWS Route 53](https://aws.amazon.com/route53/)

The AWS Route 53 DNS provider is supported with AWS and Packet clusters.
The AWS Route 53 DNS provider is supported with AWS and Equinix Metal clusters.

#### IAM permissions

Expand Down Expand Up @@ -48,11 +48,11 @@ The AWS Route 53 DNS provider requires the following IAM permissions:

### [Cloudflare](https://www.cloudflare.com/dns/)

The Cloudflare DNS provider is supported with Packet clusters.
The Cloudflare DNS provider is supported with Equinix Metal clusters.

### Manual

The Manual DNS provider is supported with Packet clusters.
The Manual DNS provider is supported with Equinix Metal clusters.

This is a special provider. When used, no DNS records are provisioned
automatically. Instead, the user is prompted to configure the necessary DNS
Expand Down Expand Up @@ -107,9 +107,9 @@ Based on the information above, the following DNS records are created:
Lokomotive currently doesn't support DNS provisioning for bare metal clusters. The user has to
create the necessary records *in advance*, before deploying a cluster.

## Packet
## Equinix Metal formerly Packet

Following is a sample record set for a Packet cluster called `my-cluster` with 3 controller nodes
Following is a sample record set for a Equinix Metal cluster called `my-cluster` with 3 controller nodes
under a zone called `example.com`. For illustration, assume the controller nodes have the following
IP addresses:

Expand Down
10 changes: 5 additions & 5 deletions docs/concepts/packet.md → docs/concepts/equinix-metal.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Packet
title: Equinix Metal
weight: 10
---

Packet is one of the cloud platforms supported by Lokomotive. This document explains various architecture decisions specific to this platform.
[Equinix Metal](https://metal.equinix.com/), formerly Packet, is one of the cloud platforms supported by Lokomotive. This document explains various architecture decisions specific to this platform.

## Blocked access to metadata service

By default, access to Packet's [metadata service](https://www.packet.com/developers/docs/servers/key-features/metadata/) is blocked for all pods. This is to prevent possible exploitation of information provided by the metadata service such as user data, which may contain secrets.
By default, access to Equinix Metal's [metadata service](https://metal.equinix.com/developers/docs/servers/metadata/) is blocked for all pods. This is to prevent possible exploitation of information provided by the metadata service such as user data, which may contain secrets.

To allow an application to access the metadata service, you can create a NetworkPolicy selecting the application.

Expand All @@ -34,5 +34,5 @@ spec:
## Flatcar Linux Customization
Flatcar Container Linux deployments on Packet can be customized with Container Linux Configs.
For more information, see [Flatcar Container Linux Customization](/docs/concepts/flatcar-container-linux.md#Customization).
Flatcar Container Linux deployments on Equinix Metal can be customized with Container Linux Configs.
For more information, see [Flatcar Container Linux Customization](./flatcar-container-linux.md#customization).
4 changes: 2 additions & 2 deletions docs/concepts/flatcar-container-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Kubelet mount points on Flatcar Container Linux:
Flatcar Container Linux can be customized via [Container Linux Configs](https://docs.flatcar-linux.org/container-linux-config-transpiler/doc/examples/) (CLC)
that are interpreted by [Ignition](https://docs.flatcar-linux.org/ignition/what-is-ignition/) (see some [examples](https://github.com/coreos/container-linux-config-transpiler/blob/master/doc/examples.md)).

Lokomotive supports defining CLC snippets for clusters running on Packet and AWS.
Lokomotive supports defining CLC snippets for clusters running on Equinix Metal and AWS.
CLC snippets can be defined both for controllers and for workers with `controller_clc_snippets` in the
controller definition, and `clc_snippets` for the worker pool definition.

Expand Down Expand Up @@ -97,4 +97,4 @@ systemd:
EOF
,
]
```
```
2 changes: 1 addition & 1 deletion docs/concepts/securing-lokomotive-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ default PSPs for general purpose application usage:
Many projects provide their own Pod Security Policies tailored to their needs which can be used
when deploying if the policies provided by Lokomotive are too strict.

## Global network policy (for Packet platform only)
## Global network policy (for Equinix Metal platform only)

Lokomotive installs Calico’s
[GlobalNetworkPolicy](https://docs.projectcalico.org/security/calico-network-policy) by default.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ volumes.

## Prerequisites

* A Lokomotive cluster accessible via `kubectl` deployed on Packet.
* A Lokomotive cluster accessible via `kubectl` deployed on Equinix Metal.

## Configuration

Expand Down
12 changes: 6 additions & 6 deletions docs/configuration-reference/components/cluster-autoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ underutilized for an extended period of time and pods can be placed on other exi

## Prerequisites

* A Lokomotive cluster accessible via `kubectl` deployed on Packet.
* A Lokomotive cluster accessible via `kubectl` deployed on Equinix Metal.

* For existing worker nodes in the cluster, you need to tag them manually for the Cluster Autoscaler
to consider.
Expand All @@ -24,7 +24,7 @@ underutilized for an extended period of time and pods can be placed on other exi

## Configuration

Currently Lokomotive supports the Cluster Autoscaler component only on the Packet platform. Support
Currently Lokomotive supports the Cluster Autoscaler component only on the Equinix Metal platform. Support
for other platforms will be added in the future.

Cluster Autoscaler component configuration example:
Expand All @@ -47,7 +47,7 @@ component "cluster-autoscaler" {
scale_down_unready_time = "20m"
packet {
# Required arguments for Packet platform
# Required arguments for Equinix Metal platform
project_id = "0b5dc3d2-949a-447d-82cd-43fbdc1ae8c0"
facility = "sjc1"
Expand All @@ -72,10 +72,10 @@ Table of all the arguments accepted by the component.
| `scale_down_unneeded_time` | How long a node should be unneeded before it is eligible for scale down. | "10m" | string | false |
| `scale_down_delay_after_add` | How long scale down should wait after a scale up. | "10m" | string | false |
| `scale_down_unready_time` | How long an unready node should be unneeded before it is eligible for scale down. | "20m" | string | false |
| `provider` | Supported provider, currently Packet. | "packet" | string | false |
| `provider` | Supported provider, currently Equinix Metal, formerly Packet. | "packet" | string | false |
| `service_monitor` | Specifies how metrics can be retrieved from a set of services. | false | bool | false |
| `packet.project_id` | Packet Project ID where the cluster is running. | - | string | true |
| `packet.facility` | Packet Facility where the cluster is running. | - | string | true |
| `packet.project_id` | Equinix Metal Project ID where the cluster is running. | - | string | true |
| `packet.facility` | Equinix Metal Facility where the cluster is running. | - | string | true |
| `packet.worker_type` | Machine type for workers spawned by the Cluster Autoscaler. | "c3.small.x86" | string | false |
| `packet_worker_channel` | Flatcar Container Linux channel to be used in workers spawned by the Cluster Autoscaler. | "stable" | string | false |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ using BPF.

This component installs the in-cluster part of Inspektor Gadget. To use the
tracing gadgets you need to install the [Inspektor Gadget kubectl
plugin](https://github.com/kinvolk/inspektor-gadget/blob/master/Documentation/install.md#installing-kubectl-gadget).
plugin](https://github.com/kinvolk/inspektor-gadget/blob/main/docs/install.md#installing-kubectl-gadget).

The [Kinvolk Web UI](web-ui.md) has integration with the traceloop gadget. When both
the Web UI and Inspektor Gadget components are installed in the cluster, a
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration-reference/components/metallb.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ on an infrastructure without native load balancing support.

On IaaS providers such as AWS or GCP, creating a Kubernetes Service of type `LoadBalancer` triggers an
automatic creation of a provider-specific load balancer which routes traffic to the Kubernetes service.
However, when running Kubernetes on bare metal environments such as [Packet](https://www.packet.com/),
However, when running Kubernetes on bare metal environments such as [Equinix Metal](https://metal.equinix.com/),
which typically don't provide native load balancer support, creating a `LoadBalancer` Service would
result in the service staying forever in the `Pending` state since no load balancer is created by
the infrastructure provider. MetalLB helps solve this problem by creating a "virtual" load balancer
for each `LoadBalancer` service. It does so using standard network protocols such as BGP and ARP.

## Prerequisites

* A Lokomotive cluster accessible via `kubectl` deployed on Packet.
* A Lokomotive cluster accessible via `kubectl` deployed on Equinix Metal.

* A [compatible](https://metallb.universe.tf/installation/network-addons/) cluster networking addon.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This component installs the OpenEBS operator.
have `iscsid` service automatically enabled and running on all worker nodes.

**NOTE:** OpenEBS requires available disks, i.e. disks that aren't mounted by anything. This means
that by default, OpenEBS does not work on machines with just a single physical disk, e.g. Packet's
that by default, OpenEBS does not work on machines with just a single physical disk, e.g. Equinix Metal's
t1.small.x86 (because the disk is used for the operating system).

## Configuration
Expand Down
Loading

0 comments on commit 09579eb

Please sign in to comment.