Skip to content

Commit e1f9ded

Browse files
committed
remove --dev from default parameters and improve docs
1 parent f0440b1 commit e1f9ded

File tree

6 files changed

+42
-18
lines changed

6 files changed

+42
-18
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ This is the <a href="https://code.visualstudio.com/">Visual Studio Code</a> exte
6262
- Configuration snippets to launch Camel application ready to accept a Camel debugger connection using JBang, Maven with Camel maven plugin or Quarkus Devs
6363
- Deploy Integration (standalone Camel file) with [Apache Camel Kubernetes](https://camel.apache.org/manual/camel-jbang-kubernetes.html) plugin.
6464
- It allows **one-click deployment into OpenShift** by default
65+
- to see logs or delete deployment see [Manage deployment lifecycle](./docs/content/kubernetes-deploy.md#manage-deployment-lifecycle)
6566
- requires Camel JBang 4.8+
66-
- for deployment into Kubernetes cluster see [how to deploy into local Kubernetes cluster](./docs/content/kubernetes-deploy.md)
67+
- for deployment into Kubernetes cluster see [how to deploy into local Kubernetes cluster](./docs/content/kubernetes-deploy.md#how-to-deploy-into-local-kubernetes-cluster)
6768

6869
### Requirements
6970

docs/content/kubernetes-deploy.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,52 @@
1-
# How to deploy into local Kubernetes cluster
1+
# Deployment into cluster using Camel JBang Kubernetes plugin
22

3-
By default, the deployment aims OpenShift cluster. In case you need to deploy into Kubernetes, there is a small modification needed:
3+
## Manage deployment lifecycle
44

5-
1) open Settings UI in VS Code
6-
2) navigate to `Extensions > Debug Adapter for Apache Camel`
7-
3) modify setting `Camel > Debug Adapter: Kubernetes Run Parameters` as you can see on picture below
5+
There are extensions which allows you to manage your deployments (which are part of an [Extension Pack for Apache Camel](https://marketplace.visualstudio.com/items?itemName=redhat.apache-camel-extension-pack)):
86

9-
![Deploy to Kubernetes cluster with Minikube](../images/kubernetes-run-params.png)
10-
11-
The picture describes how to deploy to local Kubernetes cluster using Minikube. You can use eg. also `Kind`. In that case, just change to `--cluster-type=kind`.
7+
- [OpenShift Toolkit](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-openshift-connector)
8+
- [Kubernetes](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-kubernetes-tools)
129

13-
For more information see [Camel Kubernetes plugin official documentation](https://camel.apache.org/manual/camel-jbang-kubernetes.html).
10+
or you can use a power of Camel CLI described below.
1411

15-
## Follow logs
12+
### Follow logs
1613

1714
You can use Camel CLI to obtain logs of current running integration. In terminal window execute:
1815

1916
```shell
2017
jbang camel@apache/camel kubernetes logs --name=<name>
2118
```
2219

23-
## Undeploy
20+
### Remove deployment
2421

2522
To remove current integration, you can use also Camel CLI. In this case the command is:
2623

2724
```shell
2825
jbang camel@apache/camel kubernetes delete --name=<name>
2926
```
27+
28+
#### Troubleshooting
29+
30+
For a latest releases of Camel (4.8.1+) there could be problem when deleting deployments using Camel Jbang CLI, for details you can see reported upstream issue [CAMEL-21388](https://issues.apache.org/jira/browse/CAMEL-21388).
31+
32+
In that case please try with previous version which was working better.
33+
34+
```shell
35+
jbang -Dcamel.jbang.version=4.8.0 camel@apache/camel kubernetes delete --name=<name>
36+
```
37+
38+
## How to deploy into local Kubernetes cluster
39+
40+
By default, the deployment aims OpenShift cluster. In case you need to deploy into Kubernetes, there is a small modification needed:
41+
42+
1) open Settings UI in VS Code
43+
- Linux/Windows - `File > Preferences > Settings`
44+
- macOS - `Code > Settings... > Settings`
45+
2) navigate to `Extensions > Debug Adapter for Apache Camel`
46+
3) modify setting `Camel > Debug Adapter: Kubernetes Run Parameters` as you can see on picture below
47+
48+
![Deploy to Kubernetes cluster with Minikube](../images/kubernetes-run-params.png)
49+
50+
The picture describes how to deploy to local Kubernetes cluster using Minikube. You can use eg. also `Kind`. In that case, just change to `--cluster-type=kind`.
51+
52+
For more information see [Camel Kubernetes plugin official documentation](https://camel.apache.org/manual/camel-jbang-kubernetes.html).
3.63 KB
Loading

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ This extension adds <a href="https://camel.apache.org/manual/debugger.html">Came
5353
- or Quarkus Devs
5454
- Deploy Integration (standalone Camel file) with [Apache Camel Kubernetes](https://camel.apache.org/manual/camel-jbang-kubernetes.html) plugin.
5555
- It allows **one-click deployment into OpenShift** by default
56+
- to see logs or delete deployment see [Manage deployment lifecycle](./content/kubernetes-deploy.md#manage-deployment-lifecycle)
5657
- requires Camel JBang 4.8+
57-
- for deployment into Kubernetes cluster see [how to deploy into local Kubernetes cluster](./content/kubernetes-deploy.md)
58+
- for deployment into Kubernetes cluster see [how to deploy into local Kubernetes cluster](./content/kubernetes-deploy.md#how-to-deploy-into-local-kubernetes-cluster)
5859

5960
### Advanced
6061

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,9 @@
119119
"type": "string"
120120
},
121121
"additionalProperties": false,
122-
"markdownDescription": "User defined parameters to be applied at every deploy (See [Camel JBang Kubernetes](https://camel.apache.org/manual/camel-jbang-kubernetes.html)). In case of spaces, the values needs to be enclosed with quotes. Default value is `[\"--cluster-type=openshift\", \"--dev\"]`\n\n**Note**: Excluding `--camel-version` which is already being set in `#camel.debugAdapter.CamelVersion#`.\n\nFor more possible values see: `camel kubernetes run --help` or `jbang camel@apache/camel kubernetes run --help`",
122+
"markdownDescription": "User defined parameters to be applied at every deploy (See [Camel JBang Kubernetes](https://camel.apache.org/manual/camel-jbang-kubernetes.html)). In case of spaces, the values needs to be enclosed with quotes. Default value is `[\"--cluster-type=openshift\"]`\n\n**Note**: Excluding `--camel-version` which is already being set in `#camel.debugAdapter.CamelVersion#`.\n\nFor more possible values see: `camel kubernetes run --help` or `jbang camel@apache/camel kubernetes run --help`",
123123
"default": [
124-
"--cluster-type=openshift",
125-
"--dev"
124+
"--cluster-type=openshift"
126125
]
127126
}
128127
}

src/ui-test/tests/deploy.kubernetes.run.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { killTerminal, waitUntilTerminalHasText } from '../utils';
3232
import { execSync } from 'child_process';
3333

3434
describe('Camel standalone file deployment using Camel JBang Kubernetes Run', function () {
35-
this.timeout(800_000);
35+
this.timeout(180_000);
3636

3737
let editorView: EditorView;
3838
let jbangVersion: string;
@@ -67,7 +67,7 @@ describe('Camel standalone file deployment using Camel JBang Kubernetes Run', fu
6767

6868
// using some additional steps for CAMEL 4.9.0-SNAPSHOT / 4.8.1 version
6969
// because the '--dev' parameter is not working for a deployment to Kubernetes
70-
await waitUntilTerminalHasText(action.getDriver(), ['BUILD SUCCESS'], 3_000, 240_000);
70+
await waitUntilTerminalHasText(action.getDriver(), ['BUILD SUCCESS'], 3_000, 120_000);
7171
await killTerminal();
7272

7373
const terminalView = await new BottomBarPanel().openTerminalView();

0 commit comments

Comments
 (0)