Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Commit 3532d18

Browse files
authored
Merge branch 'master' into sishida_1397_remote
2 parents 72946a6 + 0e5a028 commit 3532d18

File tree

7 files changed

+89
-25
lines changed

7 files changed

+89
-25
lines changed

docs/_data/docstoc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@
6666
- title: 'Installing Kibana and filtering logs in IBM Cloud Private'
6767
url: viewkibanalogs.html
6868

69-
- title: 'Deploying Codewind remote'
69+
- title: 'Deploying Codewind remotely'
7070
children:
7171
- title: 'Overview'
7272
url: remoteoverview.html
73-
- title: 'Configuring Codewind remote'
73+
- title: 'Configuring your remote deployment of Codewind'
7474
url: remoteconfiguring.html
7575
- title: 'Entering remote connection settings'
7676
url: remoteconnectionui.html
77-
- title: 'Removing Codewind remote'
77+
- title: 'Removing your remote deployment of Codewind'
7878
url: remoteremoving.html
7979

8080
- title: 'Performance monitoring'

docs/_data/newstoc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
- title: 'Codewind 0.7.0'
2+
url: news07.html
3+
14
- title: 'Codewind 0.6.0'
25
url: news06.html
36

docs/_documentations/mdt-che-installinfo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Installing Codewind for Eclipse Che comprises the following steps:
2828
- Because Codewind uses RWX (ReadWriteMany) volumes to provide persistent storage, you need to use NFS for storage on OpenShift 4.
2929
2. Ensure that the cluster can pull images from `docker.io/eclipse` and `quay.io/eclipse`.
3030
- Both Eclipse Che and Eclipse Codewind host their Docker images at those locations. Ensure that your cluster can pull from that registry and does not have `ImagePullPolicies` blocking it from accessing Docker Hub.
31-
3. Set up the ClusterRole for Codewind. Run `kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.6.0/setup/install_che/codewind-clusterrole.yaml`
31+
3. Set up the ClusterRole for Codewind. Run `kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.7.0/setup/install_che/codewind-clusterrole.yaml`
3232

3333
# Setting up Che
3434

@@ -38,7 +38,7 @@ The fastest way to install Eclipse Che for use with Codewind is to use the `chec
3838

3939
Complete the following steps after you install `chectl`:
4040

41-
1. Download the [codewind-che checluster yaml](https://github.com/eclipse/codewind-che-plugin/blob/master/setup/install_che/che-operator/codewind-checluster.yaml) file to your machine.
41+
1. Download the [codewind-che checluster yaml](https://github.com/eclipse/codewind-che-plugin/blob/0.7.0/setup/install_che/che-operator/codewind-checluster.yaml) file to your machine.
4242
- You can modify this file, but leave the `spec.server.cheWorkspaceClusterRole` field set to `eclipse-codewind` and the `spec.storage.preCreateSubPaths` field set to `true`.
4343
2. If you're installing on a Kubernetes platform other than OpenShift, determine your Ingress domain. If you're unsure of your Ingress domain, ask your cluster administrator.
4444
- Set the `spec.server.ingressDomain` field in the Che `.yaml` to the Ingress domain.
@@ -51,7 +51,7 @@ Complete the following steps after you install `chectl`:
5151
If you already have an existing Che install, it's relatively easy to update it for Codewind.
5252

5353
After creating the Codewind ClusterRole in the prerequisites step, run the following command, where `$NAMESPACE` is the namespace your Che workspaces run in (by default `che`):
54-
`kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.6.0/setup/install_che/codewind-rolebinding.yaml -n $NAMESPACE`
54+
`kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.7.0/setup/install_che/codewind-rolebinding.yaml -n $NAMESPACE`
5555

5656
### Enabling privileged and root containers to run
5757

@@ -86,7 +86,7 @@ http://<che ingress domain>/f?url=<hosted devfile URL>
8686

8787
Codewind includes a ready-to-use devfile with its plug-ins. Enter the following URL to create a workspace from the devfile:
8888
```
89-
http://<che ingress domain>/f?url=https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/devfiles/0.6.0/devfile.yaml
89+
http://<che ingress domain>/f?url=https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.7.0/devfiles/0.7.0/devfile.yaml
9090
```
9191

9292
For other sample devfiles, see https://github.com/kabanero-io/codewind-templates/tree/master/devfiles.

docs/_documentations/remote-configuring.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
3-
title: Configuring Codewind remote
4-
description: Configuring your environment to use Codewind remote
3+
title: Configuring your remote deployment of Codewind
4+
description: Configuring your environment to use your remote deployment of Codewind
55
keywords: users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection
66
duration: 5 minutes
77
permalink: remoteconfiguring
@@ -10,9 +10,9 @@ parent: installoncloud
1010
order: 1
1111
---
1212

13-
# Configuring Codewind remote
13+
# Configuring your remote deployment of Codewind
1414

15-
To use Codewind remote, configure your system by following these steps.
15+
Configure your remote deployment of Codewind by following these steps.
1616

1717
## Prerequisites
1818
- Install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdteclipsegettingstarted.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
@@ -21,7 +21,7 @@ To use Codewind remote, configure your system by following these steps.
2121

2222
## Procedure
2323

24-
To securely configure Codewind remote there are two options, configuring Kubernetes for Docker Desktop, or configuring a cloud deployment that does not have an Ingress NGINX controller, for example, OpenShift.
24+
To securely configure your remote deployment of Codewind, there are two options, configuring Kubernetes for Docker Desktop, or configuring a cloud deployment that does not have an Ingress NGINX controller, for example, OpenShift.
2525

2626
### Configuring Kubernetes for Docker Desktop
2727

@@ -39,7 +39,7 @@ To securely configure Codewind remote there are two options, configuring Kuberne
3939
- `export INGRESS_DOMAIN=$(kubectl get services --namespace ingress-nginx -o jsonpath='<.items[*].spec.clusterIP>')`
4040
- `sudo ifconfig lo0 alias $<INGRESS_DOMAIN>`
4141

42-
3. Create the remote deployment by entering the following `cwctl` command:
42+
3. Create the remote deployment of Codewind by entering the following `cwctl` command:
4343

4444
`cwctl install remote \`
4545
`--namespace <your_namespace> \`
@@ -56,7 +56,7 @@ To securely configure Codewind remote there are two options, configuring Kuberne
5656

5757
1. If you are deploying to a cloud that does not have an Ingress NGINX controller, for example, OpenShift, you must provide the ingress value in the `cwctl install remote \` command during installation. You can derive the `ingress` value from the cluster URL. To do this, go to the OpenShift console, for example, `https://<mycluster>|<myaddress>.nip.io:7443/console`, and then derive the `ingress` value, for example, from the previous address, this would be `apps.<mycluster>.<myaddress>.nip.io`. OpenShift also refer to this as the `routing-suffix`.
5858

59-
2. Create the remote deployment by issuing the following example `cwctl` command:
59+
2. Create the remote deployment of Codewind by issuing the following example `cwctl` command:
6060

6161
`cwctl install remote \`
6262
`--namespace <your_namespace> \`
@@ -70,6 +70,10 @@ To securely configure Codewind remote there are two options, configuring Kuberne
7070

7171
Where `keycloakAdminUser` and `keycloakAdminPassword` are the Keycloak Administrator's user credentials, and `keycloakDevUser` and `keycloakDevUserPassword` are the credentials of the first user to use the service.
7272

73+
3. Codewind is required to run as privileged and as root because it builds container images. If your cluster is running OpenShift, run the following commands where `<namespace>` is the namespace into which you plan to install Codewind:
74+
- To enable privileged containers, enter `oc adm policy add-scc-to-group privileged system:serviceaccounts:<namespace>`.
75+
- To enable containers to run as root, enter `oc adm policy add-scc-to-group anyuid system:serviceaccounts:<namespace>`.
76+
7377
### Codewind CLI command explanation and sample output
7478

7579
The `cwctl install remote` command:
@@ -84,7 +88,7 @@ The `cwctl install remote` command:
8488

8589
You see example output similar to the following, this for a Linux/macOS deployment on Kubernetes:
8690

87-
```
91+
```sh
8892
~ cwctl --insecure install remote \
8993
--namespace codewind \
9094
--kadminuser admin \

docs/_documentations/remote-overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
layout: docs
3-
title: Deploying Codewind remote
4-
description: Deploying Codewind remote
5-
keywords: users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection
3+
title: Deploying Codewind remotely
4+
description: Deploying Codewind remotely
5+
keywords: users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection, remote deployment of Codewind
66
duration: 5 minutes
77
permalink: remoteoverview
88
type: document
99
parent: installoncloud
1010
order: 1
1111
---
1212

13-
# Deploying Codewind remote
13+
# Deploying Codewind remotely
1414

15-
Codewind remote is where you develop your code locally and build and run it remotely and securely in the cloud. This option is incredibly useful because it frees up your local machine to focus purely on developing code and you use the cloud's resources to build and run your apps. Codewind enables you to develop your apps securely by securing the connection between your local editor and your remote cloud deployment. To do this, Codewind uses Keycloak, an open source identity and access management solution for modern applications and services which is highly configurable to your environment.
15+
Deploying Codewind remotely enables you to develop your code locally and then build and run it remotely and securely in the cloud. This option is incredibly useful because it frees up local resource usage and you use the cloud's resources to build and run your apps. By using [Keycloak](https://www.keycloak.org/), the connection between your local editor and your remote cloud deployment is secure.
1616

1717
You install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdteclipsegettingstarted.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
1818

@@ -22,7 +22,7 @@ You then use the Codewind features inside your preferred IDE to create a connect
2222

2323
Codewind enables you to choose which preferred IDE you want to use, however do not use two different IDEs at the same time. For the best user experience, choose which one you want to use, and disable the other.
2424

25-
To configure Codewind remote, see [Configuring Codewind remote](remoteconfiguring.html).
25+
To configure your remote deployment of Codewind, see [Configuring your remote deployment of Codewind](remoteconfiguring.html).
2626

2727
## Codewind remote security overview
2828

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
3-
title: Removing Codewind remote
4-
description: Removing Codewind remote
3+
title: Removing your remote deployment of Codewind
4+
description: Removing your remote deployment of Codewind
55
keywords: users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection
66
duration: 5 minutes
77
permalink: remoteremoving
@@ -10,7 +10,31 @@ parent: installoncloud
1010
order: 1
1111
---
1212

13-
## Removing Codewind remote
13+
# Removing your remote deployment of Codewind
1414

15-
To remove Codewind remote, enter the following `cwctl` command: `cwctl remove remote --namespace {mynamespace} --workspace {workspaceID}`
15+
The Codewind CLI `cwctl` is designed to do almost all the steps required to remove a remote deployment of Codewind by chaining together a number of Kubernetes operations.
1616

17+
There are two modes of use. You can:
18+
1. Remove Codewind.
19+
2. Remove Keycloak. A Keycloak service can provide authentication services to many Codewind deployments in different namespaces, so only remove it when you are sure it is no longer used.
20+
21+
## Removing a remote deployment of Codewind
22+
23+
To remove a remote deployment of Codewind, enter the following `cwctl` command:
24+
25+
`cwctl remove remote --namespace <namespace> --workspace <workspaceID>`
26+
27+
Where the command parameters `<namespace>` and `<workspaceID>` are used to identify which Kubernetes resources to remove. If you are unsure of the `<workspaceID>`, you can find it as part of the ingress or route URL, for example:
28+
29+
`https://codewind-gatekeeper-k412oms7.apps.mycluster.X.X.X.X.nip.io`
30+
` ^^^^^^^^`
31+
32+
## Removing Keycloak
33+
34+
WARNING: Removing Keycloak breaks all remote deployments of Codewind that are using it for authentication services.
35+
36+
If you are ready to remove Keycloak, use the following `cwctl` command:
37+
38+
`cwctl remove keycloak --namespace <namespace> --workspace <workspaceID>`
39+
40+
Where the command parameters `<namespace>` and `<workspaceID>` are used to identify which Kubernetes resources to remove.

docs/_news/news07.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: news
3+
title: New for Codewind 0.7.0
4+
description: New for Codewind 0.7.0
5+
keywords: news, new, updates, update, version, hybrid
6+
duration: 1 minute
7+
permalink: news07
8+
---
9+
10+
## Codewind 0.7.0
11+
Monday 16 December 2019
12+
13+
#### ✨ Remote Deploy with Codewind: Tech Preview ✨
14+
15+
You can now develop your code locally and securely build and deploy your apps in the cloud! Why is this cool?
16+
- Free up local resources. 👏
17+
- It's secure! 🔐 We use [Keycloak](https://keycloak.org/) to secure the connection between your local editor and remote cloud deployment.
18+
19+
Curious? [Learn more](remoteoverview.html)!
20+
21+
#### New Features and Highlights for 0.7.0
22+
23+
**OpenShift Do (odo)**
24+
- You can now easily import existing projects into Codewind and [use odo](https://github.com/eclipse/codewind/issues/1115) to build and deploy projects to your OpenShift or OKD cluster.
25+
- Introducing [support for Java template](https://github.com/eclipse/codewind/issues/450) and Java projects can build and deploy [once configured](//permalink to landing page).
26+
- You no longer have to create your [docker registry secret](https://github.com/eclipse/codewind/issues/665) in Codewind.
27+
28+
29+
30+
#### List of Fixes
31+
- Changes to the Eclipse plugin for Spring Server [post-code generation stability for OpenAPI](https://github.com/eclipse/codewind/issues/1116)
32+
- Appsody binary updated from 0.5.0 to 0.5.2 in the codewind-appsody-extension
33+
- Other security fixes

0 commit comments

Comments
 (0)