Skip to content

Commit 5904218

Browse files
Fyx typos in docs (#11)
* Doc: Update logo image in documentation and change a variable in values of the chart * fix: ensure newline at end of file in kustomization.yaml * feat: Add logo to the bundle * fix: correct version on catalog source * feat: add catalog version validation * fix: deleted wrong charts README * fix: apiVersion typo in docs
1 parent 0af572c commit 5904218

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ When adding new Custom Resource Definitions (CRDs):
8989

9090
```bash
9191
# Create a new API
92-
operator-sdk create api --group overcommit --version v1alpha1 --kind YourNewResource --resource --controller
92+
operator-sdk create api --group overcommit --version v1alphav1 --kind YourNewResource --resource --controller
9393
```
9494

9595
#### Building and Testing
@@ -167,7 +167,7 @@ k8s-overcommit-operator/
167167
├── .github/ # GitHub workflows and templates
168168
│ └── workflows/ # CI/CD pipelines
169169
├── api/ # Kubernetes API definitions
170-
│ └── v1alpha1/ # API version v1alpha1
170+
│ └── v1alphav1/ # API version v1alphav1
171171
│ ├── overcommitclass_types.go # OvercommitClass CRD definition
172172
│ ├── overcommitclass_webhook.go # Webhook implementation
173173
│ ├── overcommitclass_webhook_test.go # Webhook tests
@@ -201,7 +201,7 @@ k8s-overcommit-operator/
201201
│ │ ├── role_binding.yaml # Role binding
202202
│ │ └── service_account.yaml # Service account
203203
│ ├── samples/ # Sample Custom Resources
204-
│ │ └── overcommit_v1alpha1_overcommitclass.yaml
204+
│ │ └── overcommit_v1alphav1_overcommitclass.yaml
205205
│ └── webhook/ # Webhook configuration
206206
│ ├── kustomization.yaml
207207
│ ├── manifests.yaml
@@ -242,9 +242,9 @@ k8s-overcommit-operator/
242242

243243
### Directory Details
244244

245-
#### `/api/v1alpha1/`
245+
#### `/api/v1alphav1/`
246246

247-
Contains the Kubernetes API definitions for the v1alpha1 version:
247+
Contains the Kubernetes API definitions for the v1alphav1 version:
248248

249249
- **overcommitclass_types.go**: Defines the OvercommitClass Custom Resource Definition (CRD) structure
250250
- **overcommitclass_webhook.go**: Implements admission webhooks for validation and mutation

docs/architecture.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ The **k8s-overcommit Operator** is a Kubernetes-native operator designed to inte
4646
|-----------|---------|----------|
4747
| **Overcommit Controller** | Manages main Overcommit resource and deploys OvercommitClass controllers | [`internal/controller/overcommitclass/`](../internal/controller/overcommitclass/) |
4848
| **OvercommitClass Controller** | Watches OvercommitClass resources and configures webhooks | [`internal/resources/generate_resources_overcommit_class_controller_controller.go`](../internal/resources/generate_resources_overcommit_class_controller_controller.go) |
49-
| **Pod Mutating Webhook** | Modifies pod resource requests based on overcommit policies | [`api/v1alpha1/overcommitclass_webhook.go`](../internal/webhook/v1alphav1/mutating/pod_webhook.go) |
50-
| **OvercommitClass Validating Webhook** | Validates OvercommitClass resource specifications | [`internal/webhook/v1alphav1/mutating/pod_webhook.go`](../api/v1alpha1/overcommitclass_webhook.go) |
49+
| **Pod Mutating Webhook** | Modifies pod resource requests based on overcommit policies | [`api/v1alphav1/overcommitclass_webhook.go`](../internal/webhook/v1alphav1/mutating/pod_webhook.go) |
50+
| **OvercommitClass Validating Webhook** | Validates OvercommitClass resource specifications | [`internal/webhook/v1alphav1/mutating/pod_webhook.go`](../api/v1alphav1/overcommitclass_webhook.go) |
5151
| **Pod Validating Webhook** | Validates Pod With Unexisting Class | [`internal/webhook/v1alphav1/validating/pod_webhook.go`](../internal/webhook/v1alphav1/validating/pod_webhook.go) |
5252
| **Certificate Manager** | Generates and manages TLS certificates for webhooks | [`internal/resources/generate_issuer.go`](../internal/resources/generate_issuer.go) |
5353

@@ -112,7 +112,7 @@ flowchart TD
112112
The main configuration resource that enables the operator:
113113

114114
```yaml
115-
apiVersion: overcommit.inditex.dev/v1alpha1
115+
apiVersion: overcommit.inditex.dev/v1alphav1
116116
kind: Overcommit
117117
metadata:
118118
name: cluster
@@ -135,7 +135,7 @@ spec:
135135
Defines overcommit policies for different workload types:
136136

137137
```yaml
138-
apiVersion: overcommit.inditex.dev/v1alpha1
138+
apiVersion: overcommit.inditex.dev/v1alphav1
139139
kind: OvercommitClass
140140
metadata:
141141
name: high-density
@@ -186,7 +186,7 @@ webhooks:
186186

187187
### Webhook Logic Implementation
188188

189-
The webhook implementation in [`api/v1alpha1/overcommitclass_webhook.go`](../api/v1alpha1/overcommitclass_webhook.go) follows this logic:
189+
The webhook implementation in [`api/v1alphav1/overcommitclass_webhook.go`](../api/v1alphav1/overcommitclass_webhook.go) follows this logic:
190190

191191
1. **Label Resolution**: Check pod → namespace → default class
192192
2. **Namespace Exclusion**: Apply regex patterns to exclude critical namespaces
@@ -336,7 +336,7 @@ make run ARGS="--zap-log-level=debug"
336336
### Development Environment
337337

338338
```yaml
339-
apiVersion: overcommit.inditex.dev/v1alpha1
339+
apiVersion: overcommit.inditex.dev/v1alphav1
340340
kind: OvercommitClass
341341
metadata:
342342
name: development
@@ -350,7 +350,7 @@ spec:
350350
### Production Environment
351351

352352
```yaml
353-
apiVersion: overcommit.inditex.dev/v1alpha1
353+
apiVersion: overcommit.inditex.dev/v1alphav1
354354
kind: OvercommitClass
355355
metadata:
356356
name: production

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ kubectl apply -f https://github.com/InditexTech/k8s-overcommit-operator/deploy/o
6767
You can create your own or use the one in the route *https://github.com/InditexTech/k8s-overcommit-operator/deploy/subscription.yaml*
6868

6969
```yaml
70-
apiVersion: operators.coreos.com/v1alpha1
70+
apiVersion: operators.coreos.com/v1alphav1
7171
kind: Subscription
7272
metadata:
7373
name: k8s-overcommit-operator

0 commit comments

Comments
 (0)