Skip to content

Commit 5fd2bc1

Browse files
committed
docs: Refer to Proxmox VE correctly
The Proxmox brand guidelines https://www.proxmox.com/images/proxmox/Proxmox-Corporate-Brandguideline-2018.pdf request that products are referred to by their full or abbreviated names. Honour this request by updating our usage of the word Proxmox to refer to Proxmox VE.
1 parent b876c93 commit 5fd2bc1

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Cluster API Provider for Proxmox
1+
# Contributing to Cluster API Provider for Proxmox Virtual Environment
22

3-
Thank you for considering contributing to the Cluster API provider for Proxmox. We appreciate your time and effort to help make this project better. To ensure a smooth collaboration, please follow the guidelines below.
3+
Thank you for considering contributing to the Cluster API Provider for Proxmox VE. We appreciate your time and effort to help make this project better. To ensure a smooth collaboration, please follow the guidelines below.
44

55
## Code of Conduct
66

@@ -59,4 +59,4 @@ Ensure that your changes are reflected in the documentation. If you are introduc
5959
If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.
6060

6161
## Thank You
62-
Thank you for your contribution! Your efforts help make the Cluster API provider for Proxmox better for everyone. We appreciate your dedication to the project and the CNCF community.
62+
Thank you for your contribution! Your efforts help make the Cluster API Provider for Proxmox VE better for everyone. We appreciate your dedication to the project and the CNCF community.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Kubernetes Cluster API Provider for Proxmox - CAPMOX
1+
# Kubernetes Cluster API Provider for Proxmox Virtual Environment - CAPMOX
22

33
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_cluster-api-provider-proxmox&metric=alert_status&token=fb1b4c0a87d83a780c76c21be0f89dc13efc2ca0)](https://sonarcloud.io/summary/new_code?id=ionos-cloud_cluster-api-provider-proxmox)
44

55
## Overview
66

77
The [Cluster API](https://github.com/kubernetes-sigs/cluster-api) brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
8-
Cluster API Provider for Proxmox is a concrete implementation of Cluster API for Proxmox VE.
8+
Cluster API Provider for Proxmox VE is a concrete implementation of Cluster API for Proxmox VE.
99

10-
## Launching a Kubernetes cluster on Proxmox
10+
## Launching a Kubernetes cluster on Proxmox VE
1111

12-
Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox.
12+
Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox VE.
1313

1414
## Compatibility with Cluster API and Kubernetes Versions
1515
This provider's versions are compatible with the following versions of Cluster API:

docs/Development.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Table of contents
88
* [About CAPMOX](#about-capmox)
99
* [CAPMOX Dependencies](#capmox-dependencies)
1010
* [Getting Started](#getting-started)
11-
* [Proxmox API Token](#promox-api-token)
11+
* [Proxmox VE API Token](#promox-api-token)
1212
* [Setting up a development environment](#how-to-setup-a-development-environment)
1313
* [Running Tilt](#running-tilt)
1414
* [Make Targets](#make-targets)
@@ -19,7 +19,7 @@ Table of contents
1919
* [Uninstalling CAPMOX](#uninstalling-capmox)
2020

2121
## About CAPMOX
22-
CAPMOX is a Kubernetes Cluster API provider for Proxmox.
22+
CAPMOX is a Kubernetes Cluster API provider for Proxmox Virtual Environment.
2323

2424
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
2525

@@ -55,8 +55,8 @@ in cluster-api's Tiltfile do not hold. We strongly advise against this approach.
5555

5656
If you're having trouble setting any of this up, check the [Troubleshooting](Troubleshooting.md) docs.
5757

58-
### Proxmox API Token
59-
Cluster-api-provider-proxmox requires a running proxmox instance and an API token for access. See the [Proxmox wiki](https://pve.proxmox.com/wiki/Proxmox_VE_API#API_Tokens)
58+
### Proxmox VE API Token
59+
Cluster-api-provider-proxmox requires a running Proxmox VE instance and an API token for access. See the [Proxmox wiki](https://pve.proxmox.com/wiki/Proxmox_VE_API#API_Tokens)
6060
for more information.
6161

6262
## How to setup a development environment
@@ -90,14 +90,14 @@ for more information.
9090
}
9191
}
9292
```
93-
This file instructs Tilt to use the Proxmox and ipam-provider-in-cluster repositories. `allowed_contexts` is used to add
93+
This file instructs Tilt to use the cluster-api-provider-proxmox and ipam-provider-in-cluster repositories. `allowed_contexts` is used to add
9494
allowed clusters other than kind (which is always implicitly enabled).
9595

9696
- If you don't have a cluster, create a new kind cluster:
9797
```
9898
kind create cluster --name capi-test
9999
```
100-
- cluster-api-provider-proxmox uses environment variables to connect to Proxmox. These need to be set in the shell which spawns Tilt.
100+
- cluster-api-provider-proxmox uses environment variables to connect to Proxmox VE. These need to be set in the shell which spawns Tilt.
101101
Tilt will pass these to the respective Kubernetes pods created. All variables are documented in `../cluster-api-provider-proxmox/envfile.example`.
102102
Copy `../cluster-api-provider-proxmox/envfile.example` to `../cluster-api-provider-proxmox/envfile` and make changes pertaining to your configuration.
103103
For documentation on environment variables, see [usage](Usage.md#environment-variables)

docs/Usage.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
This is a guide on how to get started with Cluster API Provider Proxmox. To learn more about cluster API in more depth, check out the [Cluster API book](https://cluster-api.sigs.k8s.io/).
3+
This is a guide on how to get started with Cluster API Provider for Proxmox Virtual Environment. To learn more about cluster API in more depth, check out the [Cluster API book](https://cluster-api.sigs.k8s.io/).
44

55
Table of contents
66
=================
@@ -10,7 +10,7 @@ Table of contents
1010
* [Dependencies](#dependencies)
1111
* [Quick start](#quick-start)
1212
* [Pre-requisites](#pre-requisites)
13-
* [Configuring and installing Cluster API Provider Proxmox in a management cluster](#configuring-and-installing-cluster-api-provider-proxmox-in-a-management-cluster)
13+
* [Configuring and installing Cluster API Provider for Proxmox VE in a management cluster](#configuring-and-installing-cluster-api-provider-for-proxmox-ve-in-a-management-cluster)
1414
* [Create a Workload Cluster](#create-a-workload-cluster)
1515
* [Check the status of the cluster](#check-the-status-of-the-cluster)
1616
* [Access the cluster](#access-the-cluster)
@@ -28,25 +28,25 @@ Table of contents
2828

2929
In order to deploy a K8s cluster with CAPMOX, you require the following:
3030

31-
* Proxmox template in order to be able to create a cluster.
31+
* Proxmox VE template in order to be able to create a cluster.
3232

3333
* You can build VM template using [image-builder](https://github.com/kubernetes-sigs/image-builder)
34-
* **we recommend using** [the Proxmox builder](https://image-builder.sigs.k8s.io/capi/providers/proxmox)
34+
* **we recommend using** [the Proxmox VE builder](https://image-builder.sigs.k8s.io/capi/providers/proxmox)
3535
* OR by [Building Raw Images](https://image-builder.sigs.k8s.io/capi/providers/proxmox)
3636

3737
* clusterctl, which you can download it from Cluster API (CAPI) [releases](https://github.com/kubernetes-sigs/cluster-api/releases) on GitHub.
3838

3939
* Kubernetes cluster for running your CAPMOX controller
4040

41-
* Proxmox Bridge e.g. `vmbr0` with an IP Range for VMs.
41+
* Proxmox VE Bridge e.g. `vmbr0` with an IP Range for VMs.
4242

4343
## Quick start
4444

4545
### Prerequisites
4646

47-
In order to install Cluster API Provider Proxmox, you need to have a Kubernetes cluster up and running, and `clusterctl` installed.
47+
In order to install Cluster API Provider for Proxmox VE, you need to have a Kubernetes cluster up and running, and `clusterctl` installed.
4848

49-
We need to add the Proxmox infrastructure provider and the IPAM provider to your clusterctl config file `~/.cluster-api/clusterctl.yaml`:
49+
We need to add the Proxmox VE infrastructure provider and the IPAM provider to your clusterctl config file `~/.cluster-api/clusterctl.yaml`:
5050

5151
```yaml
5252
providers:
@@ -58,7 +58,7 @@ providers:
5858
type: InfrastructureProvider
5959
```
6060
61-
### Configuring and installing Cluster API Provider Proxmox in a management cluster
61+
### Configuring and installing Cluster API Provider for Proxmox VE in a management cluster
6262
6363
Before you can create a cluster, you need to configure your management cluster.
6464
This is done by setting up the environment variables for CAPMOX and generating a cluster manifest.
@@ -67,15 +67,15 @@ clusterctl requires the following variables, which should be set in `~/.cluster-
6767

6868
```env
6969
## -- Controller settings -- ##
70-
PROXMOX_URL: "https://pve.example:8006" # The Proxmox host
71-
PROXMOX_TOKEN: "root@pam!capi" # The Proxmox tokenID for authentication
72-
PROXMOX_SECRET: "REDACTED" # The secret associated with the tokenID
70+
PROXMOX_URL: "https://pve.example:8006" # The Proxmox VE host
71+
PROXMOX_TOKEN: "root@pam!capi" # The Proxmox VE TokenID for authentication
72+
PROXMOX_SECRET: "REDACTED" # The secret associated with the TokenID
7373
7474
7575
## -- Required workload cluster default settings -- ##
7676
PROXMOX_SOURCENODE: "pve" # The node that hosts the VM template to be used to provision VMs
7777
TEMPLATE_VMID: "100" # The template VM ID used for cloning VMs
78-
ALLOWED_NODES: "[pve1,pve2,pve3, ...]" # The Proxmox nodes used for VM deployments
78+
ALLOWED_NODES: "[pve1,pve2,pve3, ...]" # The Proxmox VE nodes used for VM deployments
7979
VM_SSH_KEYS: "ssh-ed25519 ..., ssh-ed25519 ..." # The ssh authorized keys used to ssh to the machines.
8080
8181
## -- networking configuration-- ##
@@ -84,7 +84,7 @@ NODE_IP_RANGES: "[10.10.10.5-10.10.10.50, ...]" # The IP ranges fo
8484
GATEWAY: "10.10.10.1" # The gateway for the machines network-config.
8585
IP_PREFIX: "25" # Subnet Mask in CIDR notation for your node IP ranges
8686
DNS_SERVERS: "[8.8.8.8,8.8.4.4]" # The dns nameservers for the machines network-config.
87-
BRIDGE: "vmbr1" # The Proxmox network device for VMs
87+
BRIDGE: "vmbr1" # The network bridge device for Proxmox VE VMs
8888
8989
## -- xl nodes-- ##
9090
BOOT_VOLUME_DEVICE: "scsi0" # The device used for the boot disk.

0 commit comments

Comments
 (0)