You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to Cluster API Provider for Proxmox
1
+
# Contributing to Cluster API Provider for Proxmox Virtual Environment
2
2
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.
4
4
5
5
## Code of Conduct
6
6
@@ -59,4 +59,4 @@ Ensure that your changes are reflected in the documentation. If you are introduc
59
59
If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.
60
60
61
61
## 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.
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.
9
9
10
-
## Launching a Kubernetes cluster on Proxmox
10
+
## Launching a Kubernetes cluster on Proxmox VE
11
11
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.
13
13
14
14
## Compatibility with Cluster API and Kubernetes Versions
15
15
This provider's versions are compatible with the following versions of Cluster API:
Copy file name to clipboardExpand all lines: docs/Development.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Table of contents
8
8
*[About CAPMOX](#about-capmox)
9
9
*[CAPMOX Dependencies](#capmox-dependencies)
10
10
*[Getting Started](#getting-started)
11
-
*[Proxmox API Token](#promox-api-token)
11
+
*[Proxmox VE API Token](#promox-api-token)
12
12
*[Setting up a development environment](#how-to-setup-a-development-environment)
13
13
*[Running Tilt](#running-tilt)
14
14
*[Make Targets](#make-targets)
@@ -19,7 +19,7 @@ Table of contents
19
19
*[Uninstalling CAPMOX](#uninstalling-capmox)
20
20
21
21
## About CAPMOX
22
-
CAPMOX is a Kubernetes Cluster API provider for Proxmox.
22
+
CAPMOX is a Kubernetes Cluster API provider for Proxmox Virtual Environment.
23
23
24
24
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
25
25
@@ -55,8 +55,8 @@ in cluster-api's Tiltfile do not hold. We strongly advise against this approach.
55
55
56
56
If you're having trouble setting any of this up, check the [Troubleshooting](Troubleshooting.md) docs.
57
57
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)
60
60
for more information.
61
61
62
62
## How to setup a development environment
@@ -90,14 +90,14 @@ for more information.
90
90
}
91
91
}
92
92
```
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
94
94
allowed clusters other than kind (which is always implicitly enabled).
95
95
96
96
- If you don't have a cluster, create a new kind cluster:
97
97
```
98
98
kind create cluster --name capi-test
99
99
```
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.
101
101
Tilt will pass these to the respective Kubernetes pods created. All variables are documented in `../cluster-api-provider-proxmox/envfile.example`.
102
102
Copy `../cluster-api-provider-proxmox/envfile.example` to `../cluster-api-provider-proxmox/envfile` and make changes pertaining to your configuration.
103
103
For documentation on environment variables, see [usage](Usage.md#environment-variables)
Copy file name to clipboardExpand all lines: docs/Usage.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Usage
2
2
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/).
4
4
5
5
Table of contents
6
6
=================
@@ -10,7 +10,7 @@ Table of contents
10
10
* [Dependencies](#dependencies)
11
11
* [Quick start](#quick-start)
12
12
* [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)
14
14
* [Create a Workload Cluster](#create-a-workload-cluster)
15
15
* [Check the status of the cluster](#check-the-status-of-the-cluster)
16
16
* [Access the cluster](#access-the-cluster)
@@ -28,25 +28,25 @@ Table of contents
28
28
29
29
In order to deploy a K8s cluster with CAPMOX, you require the following:
30
30
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.
32
32
33
33
* You can build VM template using [image-builder](https://github.com/kubernetes-sigs/image-builder)
0 commit comments