Skip to content

Commit

Permalink
adjust resources to CamelCase (#14991)
Browse files Browse the repository at this point in the history 
* adjust resources to CamelCase

* Apply Maja's suggestion

Co-authored-by: Maja Szostok <[email protected]>

* adjust resources to CamelCase

* found another "Config Map"

* review Eventing capitalization

* Open Service Broker without camel case

Co-authored-by: Maja Szostok <[email protected]>
  • Loading branch information
@NHingerl @majakurcius
NHingerl and majakurcius authored Aug 4, 2022
1 parent 3086a77 commit 8e602ae
Show file tree
Hide file tree
Showing 108 changed files with 278 additions and 278 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ If you would like to join us and work together on the Kyma project, there are so
- Downloading additional tools modules with the `go get` command

- Kubernetes basic skillset:
- Understanding basic [Kubernetes architecture](https://shipit.dev/posts/kubernetes-overview-diagrams.html) and basic concepts such as: Namespace, Pod, Deployment, Secret, Config Map, Replica Set, Service, Custom Resource Definition, Kubernetes Control Loop; understanding Kubernetes Design Patterns such as sidecars and init containers
- Understanding basic [Kubernetes architecture](https://shipit.dev/posts/kubernetes-overview-diagrams.html) and basic concepts such as: Namespace, Pod, Deployment, Secret, ConfigMap, ReplicaSet, Service, CustomResourceDefinition, Kubernetes Control Loop; understanding Kubernetes Design Patterns such as sidecars and init containers
- Using a kubeconfig file to connect to a cluster
- Browsing cluster resources using `kubectl` commands and editing Kubernetes resources using Terminal
- Applying YAML files to a cluster with Kubernetes resources
Expand Down
4 changes: 2 additions & 2 deletions components/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ This table lists the available types:

| Type | Description | Example|
|---|---|---|
| **controller** | A [Kubernetes Controller](https://kubernetes.io/docs/concepts/workloads/controllers/) which reacts to a standard Kubernetes resource or manages [Custom Resource Definition](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/) resources. The component's name reflects the name of the primary resource it controls.| Function-controller |
| **controller** | A [Kubernetes Controller](https://kubernetes.io/docs/concepts/workloads/controllers/) which reacts to a standard Kubernetes resource or manages [CustomResourceDefinition](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/) resources. The component's name reflects the name of the primary resource it controls.| Function-controller |
| **controller-manager** |A daemon that embeds all [Kubernetes Controllers](https://kubernetes.io/docs/concepts/workloads/controllers/) of a domain. Such an approach brings operational benefits in comparison to shipping all controllers separately. A `controller-manager` takes the name of the domain it belongs to. | - |
| **operator** |is a [Kubernetes Operator](https://coreos.com/operators/) which covers the application-specific logic behind the operation of the application, such as steps to upscale a stateful application. It reacts on changes made to custom resources derived from a given [Custom Resource Definition](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/). It uses the name of the application it operates. | telemetry-operator |
| **operator** |is a [Kubernetes Operator](https://coreos.com/operators/) which covers the application-specific logic behind the operation of the application, such as steps to upscale a stateful application. It reacts on changes made to custom resources derived from a given [CustomResourceDefinition](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/). It uses the name of the application it operates. | telemetry-operator |
| **job** | A [Kubernetes Job](https://kubernetes.io/docs/tasks/job/) which performs a task once or periodically. It uses the name of the task it performs. |istio-patch-job (not renamed yet)|
| **proxy** | Acts as a proxy for an existing component, usually introducing a security model for this component. It uses the component's name. | - |
| **service** | Serves an HTTP/S-based API, usually securely exposed to the public. It uses the domain name and the API it serves.| - |
Expand Down
9 changes: 4 additions & 5 deletions components/binding/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## Overview

Kyma Binding is a component that allows you to inject values from a Secret or Config Map to the
resources such as Deployment, which have a Pod template underneath.
Kyma Binding is a component that allows you to inject values from a Secret or ConfigMap to the resources such as Deployment, which have a Pod template underneath.

## Prerequisites

Expand All @@ -20,13 +19,13 @@ helm install binding ./charts/binding --wait

Go through the short tutorial that presents the useage and capabilities of the component.

1. Register a Target Kind. It's a resource that defines how and where environments can be injected.
1. Register a TargetKind. It's a resource that defines how and where environments can be injected.

```bash
kubectl apply -f ./examples/target-kind-deployment.yaml
```

2. Check if the Target Kind is registered properly:
2. Check if the TargetKind is registered properly:

```bash
kubectl get targetkinds.bindings.kyma-project.io
Expand Down Expand Up @@ -60,7 +59,7 @@ kubectl apply -f ./examples/secret-binding.yaml

8. Check again the browser. Environments are now injected under the **Password** and **Token** keys.

9. You can also inject environments from a Config Map. To check this out, create a Config Map and a Binding that injects parameters to our Pod:
9. You can also inject environments from a ConfigMap. To check this out, create a ConfigMap and a Binding that injects parameters to our Pod:

```bash
kubectl apply -f ./examples/config-map.yaml
Expand Down
2 changes: 1 addition & 1 deletion components/central-application-connectivity-validator/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Central Application Connectivity Validator has the following parameters:
- **eventingPathPrefixV2** is the path prefix for which requests are forwarded to the Eventing Publisher V2 API. The default value is `/v2/events`.
- **eventingPublisherHost** is the host and the port of the Eventing Publisher Proxy. The default value is `events-api:8080`.
- **eventingDestinationPath** is the destination path for the requests coming to the Eventing. The default value is `/`.
- **eventingPathPrefixEvents** is the prefix of paths that is directed to the Cloud Events based Eventing. The default value is `/events`.
- **eventingPathPrefixEvents** is the prefix of paths that is directed to the CloudEvents-based Eventing. The default value is `/events`.
- **appNamePlaceholder** is the path URL placeholder used for the application name. The default value is `%%APP_NAME%%`.
- **cacheExpirationSeconds** is the expiration time for client IDs stored in cache expressed in seconds. The default value is `90`.
- **cacheCleanupIntervalSeconds** is the clean-up interval controlling how often the client IDs stored in cache are removed. The default value is `15`.
Expand Down
6 changes: 3 additions & 3 deletions components/event-publisher-proxy/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ $ ko apply -f config/event-publisher-proxy/

### Send Events

This command supports **cloud events**:
This command supports **CloudEvents**:
```bash
curl -v -X POST \
-H "Content-Type: application/cloudevents+json" \
Expand Down Expand Up @@ -87,14 +87,14 @@ curl -v -X GET \

| Environment Variable | Default Value | Description |
| ----------------------- | ------------- |------------------------------------------------------------------------------------------- |
| INGRESS_PORT | 8080 | The ingress port for the Cloud Events Gateway Proxy. |
| INGRESS_PORT | 8080 | The ingress port for the CloudEvents Gateway Proxy. |
| MAX_IDLE_CONNS | 100 | The maximum number of idle (keep-alive) connections across all hosts. Zero means no limit. |
| MAX_IDLE_CONNS_PER_HOST | 2 | The maximum idle (keep-alive) connections to keep per-host. Zero means the default value. |
| REQUEST_TIMEOUT | 5s | The timeout for the outgoing requests to the Messaging server. |
| CLIENT_ID | | The Client ID used to acquire Access Tokens from the Authentication server. |
| CLIENT_SECRET | | The Client Secret used to acquire Access Tokens from the Authentication server. |
| TOKEN_ENDPOINT | | The Authentication Server Endpoint to provide Access Tokens. |
| EMS_PUBLISH_URL | | The Messaging Server Endpoint that accepts publishing Cloud Events to it. |
| EMS_PUBLISH_URL | | The Messaging Server Endpoint that accepts publishing CloudEvents to it. |
| BEB_NAMESPACE | | The name of the namespace in BEB. |
| EVENT_TYPE_PREFIX | | The prefix of the eventType as per the BEB event specification. |

Expand Down
12 changes: 6 additions & 6 deletions components/eventing-controller/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

This component contains controllers for various custom resource definitions related to Eventing in Kyma. The following controller comes with this container:
This component contains controllers for various CustomResourceDefinitions related to Eventing in Kyma. The following controller comes with this container:

- [`controller`](https://github.com/kyma-project/kyma/blob/main/components/eventing-controller/cmd/eventing-controller/main.go) which lays down the Eventing infrastructure in Business Event Bus (BEB) or [NATS](https://docs.nats.io/nats-concepts/intro).

Expand Down Expand Up @@ -42,7 +42,7 @@ This section explains how to use the Eventing Controller. It expects the followi
| **For both** | |
| `APP_LOG_FORMAT` | The format of the Application logs. |
| `APP_LOG_LEVEL` | The level of the Application logs. |
| `BACKEND_CR_NAMESPACE` | The namespace of the Backend Resource (CR). |
| `BACKEND_CR_NAMESPACE` | The Namespace of the Backend Resource (CR). |
| `BACKEND_CR_NAME` | The name of the Backend Resource (CR). |
| `PUBLISHER_IMAGE` | The image of the Event Publisher Proxy. |
| `PUBLISHER_IMAGE_PULL_POLICY` | The pull-policy of the Event Publisher Proxy. |
Expand Down Expand Up @@ -92,13 +92,13 @@ The additional command line arguments are:
| `max-reconnects` | The maximum number of reconnection attempts (NATS). | 10 | NATS |
| `reconnect-wait` | Wait time between reconnection attempts (NATS). | 1 second | NATS |

- To install the custom resource definitions in a cluster, run:
- To install the CustomResourceDefinitions in a cluster, run:

```sh
make install
```

- To uninstall the custom resource definitions in a cluster, run:
- To uninstall the CustomResourceDefinitions in a cluster, run:

```sh
make uninstall
Expand Down Expand Up @@ -145,7 +145,7 @@ kubebuilder create api --group batch --version v1 --kind CronJob
make manifests
```

- Update fields in the `spec` of an existing custom resource definition by modifying the Go file for the type i.e. `api/version/<crd>_types.go`. For example, `api/v1alpha1/subscriptions_types.go` for Subscriptions CRD. After that, execute the following command to generate boilerplate code:
- Update fields in the `spec` of an existing CustomResourceDefinition by modifying the Go file for the type i.e. `api/version/<crd>_types.go`. For example, `api/v1alpha1/subscriptions_types.go` for Subscriptions CRD. After that, execute the following command to generate boilerplate code:

```sh
make manifests
Expand All @@ -156,7 +156,7 @@ make manifests
make copy-crds
```

- Add the necessary changes manually in the sample custom resources after updating fields for an existing custom resource definition inside the folder `config/samples/`. For example, for subscriptions, update the fields manually in `config/samples/eventing_v1alpha1_subscriptioncomponents/eventing-controller/config/crd/bases/eventing.kyma-project.io_subscriptions.yaml.yaml`
- Add the necessary changes manually in the sample custom resources after updating fields for an existing CustomResourceDefinition inside the folder `config/samples/`. For example, for subscriptions, update the fields manually in `config/samples/eventing_v1alpha1_subscriptioncomponents/eventing-controller/config/crd/bases/eventing.kyma-project.io_subscriptions.yaml.yaml`

- The kubebuilder bootstrapped files have been reduced to the bare minimum. If at a later point one of these files are required (e.g. for a webhook), get them either from [this PR](https://github.com/kyma-project/kyma/pull/9510/commits/6ce5b914c5ef175dea45c27ccca826becb1b5818) or create a sample kubebuilder project and copy all required files from there:

Expand Down
6 changes: 3 additions & 3 deletions components/eventing-controller/config/crd/external/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# External custom resource definitions
# External Custom Resource Definitions

## Overview

This directory contains the external custom resource definitions used for testing purposes.
This directory contains the external CustomResourceDefinitions used for testing purposes.

## Custom resource definitions
## Custom Resource Definitions

| Kind | API Version | Description | Reference |
|---------|----------------------------------|--------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
Expand Down
Loading

0 comments on commit 8e602ae

Please sign in to comment.