generated from camel.apache.org/component
Update wiki Home page for kubernetes-services
parent
7a69a89085
commit
3d733a414f
68
Home.md
68
Home.md
@ -1,21 +1,61 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# Kubernetes Services
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Perform operations on Kubernetes Services and get notified on Service changes.
|
||||
|
||||
## Step 1: Create a release
|
||||
From the project space, click on **"Create a release"**
|
||||
## Metadata
|
||||
|
||||
The new version is automatically available in the list
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Scheme | `kubernetes-services` |
|
||||
| Support Level | Stable |
|
||||
| Labels | container,cloud |
|
||||
| Version | 4.10.2 |
|
||||
|
||||
## Step 2: Deploy
|
||||
Click on **"Deploy"**
|
||||
## Maven Dependency
|
||||
|
||||
- **Version:** Select the desired release
|
||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
||||
- **Configuration:** Select the configuration source
|
||||
- **Resources:** Set CPU and Memory
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>org.apache.camel</groupId>
|
||||
<artifactId>camel-kubernetes</artifactId>
|
||||
<version>4.10.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Endpoint Properties
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `masterUrl` | string | ✓ | | URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc. |
|
||||
| `apiVersion` | string | | | The Kubernetes API Version to use |
|
||||
| `dnsDomain` | string | | | The dns domain, used for ServiceCall EIP |
|
||||
| `kubernetesClient` | object | | | Default KubernetesClient to use if provided |
|
||||
| `namespace` | string | | | The namespace |
|
||||
| `portName` | string | | | The port name, used for ServiceCall EIP |
|
||||
| `portProtocol` | string | | `tcp` | The port protocol, used for ServiceCall EIP |
|
||||
| `crdGroup` | string | | | The Consumer CRD Resource Group we would like to watch |
|
||||
| `crdName` | string | | | The Consumer CRD Resource name we would like to watch |
|
||||
| `crdPlural` | string | | | The Consumer CRD Resource Plural we would like to watch |
|
||||
| `crdScope` | string | | | The Consumer CRD Resource Scope we would like to watch |
|
||||
| `crdVersion` | string | | | The Consumer CRD Resource Version we would like to watch |
|
||||
| `labelKey` | string | | | The Consumer Label key when watching at some resources |
|
||||
| `labelValue` | string | | | The Consumer Label value when watching at some resources |
|
||||
| `poolSize` | integer | | `1` | The Consumer pool size |
|
||||
| `resourceName` | string | | | The Consumer Resource Name we would like to watch |
|
||||
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
|
||||
| `operation` | string | | | Producer operation to do on Kubernetes |
|
||||
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
|
||||
| `connectionTimeout` | integer | | | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. |
|
||||
| `caCertData` | string | | | The CA Cert Data |
|
||||
| `caCertFile` | string | | | The CA Cert File |
|
||||
| `clientCertData` | string | | | The Client Cert Data |
|
||||
| `clientCertFile` | string | | | The Client Cert File |
|
||||
| `clientKeyAlgo` | string | | | The Key Algorithm used by the client |
|
||||
| `clientKeyData` | string | | | The Client Key data |
|
||||
| `clientKeyFile` | string | | | The Client Key file |
|
||||
| `clientKeyPassphrase` | string | | | The Client Key Passphrase |
|
||||
| `oauthToken` | string | | | The Auth Token |
|
||||
| `password` | string | | | Password to connect to Kubernetes |
|
||||
| `trustCerts` | boolean | | | Define if the certs we used are trusted anyway or not |
|
||||
| `username` | string | | | Username to connect to Kubernetes |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user