This chart creates a CodeTogether server deployment on a Kubernetes cluster using the Helm package manager.
This chart has been created with Helm v3 and tested it with:
- Kubernetes v1.18+
- OpenShift v4.5+
- Helm v3.5+
- MySQL v8.0+
The following table lists configurable parameters of the CodeTogether chart and their default values (A-Z).
| Parameter | Description | Default |
|---|---|---|
av.enabled |
Enables CodeTogether A/V sessions (if set to false, A/V will be turned off ) |
false |
av.serverIP |
Sets the LAN IP to use for A/V sessions | auto |
av.stunServers.enabled |
Enables use of private STUN servers for A/V | false |
av.stunServers.server |
Set your private coTURN fallback server | coturn.example.com |
av.stunServers.secret |
The secret you set up in the coTURN server | my-secret |
codetogether.mode |
Sets Locator running mode: direct, locator-central or locator-edge |
direct |
codetogether.url |
The CodeTogether server URL that matches the Ingress config (if enabled) | https://codetogether.local |
codetogether.trustAllCerts |
Allow the use of untrusted certifictates | true |
codetogether.timeZone.enabled |
Enables a customized TZ for CodeTogether container (default is UTC) | false |
codetogether.timeZone.region |
Sets the TZ for the CodeTogether container (https://nodatime.org/TimeZones) | America/Chicago |
dashboard.enabled |
Enables credentials customization for the '/dashboard' area. If not enabled, random credentials are generated | false |
dashboard.username |
Username for the '/dashboard' area. Ignored if dashboard.existingSecret is provided |
my-dashboard-username |
dashboard.password |
Password for the '/dashboard' area. Ignored if dashboard.existingSecret is provided |
my-dashboard-password |
dashboard.existingSecret |
Name of existing secret to use for Dashboard credentials. dashboard.username and dashboard.password will be ignored and picked up from this secret. |
"" |
direct.metrics.statsdEnabled |
Enables Metrics collecting | false |
direct.metrics.statsdHost |
StatsD host FQDN (like a Graphite server) | https://my-graphite-fqdn |
direct.metrics.statsdPort |
StatsD server port | 8125 |
direct.metrics.statsdProtocol |
StatsD server protocol | UDP |
direct.metrics.prometheusEnabled |
Enables Prometheus metrics collecting | false |
image.pullPolicy |
Container image pull policy | Always |
image.repository |
Repository URL from which the CodeTogether image will be pulled out | hub.edge.codetogether.com/releases/codetogether |
image.tag |
Container image tag | latest |
imageCredentials.enabled |
Set this to 'true' if you are meant to login into a Registry | true |
imageCredentials.enabled |
The registry FQDN you want to login into | hub.edge.codetogether.com |
imageCredentials.username |
Your registry login user name | my-customer-username |
imageCredentials.password |
Your registry login password | my-customer-password |
imageCredentials.email |
Your registry login email | unused |
ingress.annotations |
Specify ingress class | kubernetes.io/ingress.class: nginx |
ingress.enabled |
Enable ingress controller resource | true |
ingress.className |
IngressClass used for ingress configuration | `` |
ingress.tls |
Ingress TLS configuration | [{secretName': codetogether-tls}] |
license.licensee |
The license provided by Genuitec | Example |
license.maxConnections |
The maximum connection allowed by the license | 0 |
license.expiration |
The license expiration date | 1970/12/31 |
license.signature |
The license signature | 123456789abcdef |
locatorCentral.database.host |
Sets database host IP - it must be reachable from the CodeTogether container | 10.10.0.2 |
locatorCentral.database.port |
Sets database port | 3306 |
locatorCentral.database.schema |
Sets database schema (database) name | codetogether |
locatorCentral.database.dialect |
Sets database dialect (either MySQL or Postgress) | mysql |
locatorCentral.database.user |
Sets database user name | my-db-username |
locatorCentral.database.password |
Sets database password | my-db-password |
locatorCentral.database.sslEnabled |
Enable SSL security to database | false |
locatorCentral.database.sslKey |
Sets database SSL client key (base64 encoded) | |
locatorCentral.database.sslCA |
Sets database SSL client certificate authority (base64 encoded) | |
locatorCentral.database.sslCert |
Sets database SSL client certificate (base64 encoded) | |
locatorEdge.locator |
Sets JSON string configuration for locator mode database |
[sample included in the values.yaml file] |
locatorEdge.region |
Sets a region in edge-with-locator mode so sessions can be routed out |
default |
openshift.enabled |
Set this value to 'true' ONLY if you are deploying into OpenShift | false |
service.type |
Service type | ClusterIP |
service.port |
CodeTogether exposed service port | 443 |
sso.enabled |
Enables SSO feature | false |
sso.provider |
SSO vendor's name (supported values: OKTA, MICROSOFT, IDCS, KEYCLOAK or ONELOGIN) | OKTA |
sso.systemBaseUrl |
The base URL for your identity system - aka. Domain, Realm, etc. | https://OKTA_DOMAIN/oauth2/default |
sso.clientID |
The SSO client ID | my-oidc-id |
sso.clientSecret |
The SSO client secret | my-oidc-secret |
sso.jwksEndPointEnabled |
Set to 'true' when the SSO URL for accessing public keys is protected (IDCS) | false |
proxy.enabled |
Enables proxy | false |
proxy.uri |
Sets the proxy URI (format: http://myuser:[email protected]:port). Ignored if proxy.existingSecret with key proxy-uri is provided |
"" |
proxy.existingSecret |
Name of existing secret to use for proxy URI. proxy.uri will be ignored and picked up from this secret. |
`` |
It is a best Kubernetes practice to have a namespace per collection of same aplpication objects - such as secrets, pods, etc. To create a namespace for CodeTogether objects in Kubernetes and then switch to it in the current session just run:
Kubernetes:
$ kubectl create namespace codetogether$ kubectl config set-context --current --namespace=codetogetherOpenShift:
$ oc new-project codetogetherNow, you are in the codetogether namespace so can create the below K8s secrets and deployment.
If your are using OpenShift, please set this value to true in your customized codetogether-values.yaml file:
openshift:
enabled: true
By default, CodeTogether will run in direct mode. For a multi-server deployment, you must run a single CodeTogether locator in locator-central mode, and as many edge servers as required in locator-edge mode.
So, in order to run CodeTogether as either locator-central or locator-edge mode:
- Make sure you already have the right CodeTogether license provided by our Sales Team.
- Enter a CodeTogether running mode in your
codetogether-values.yamlfile along with required extra settings for eitherdirect.*,locatorCentral.*orlocatorEdge.*sections. - If you are running CodeTogether as
locator-central, make sure you already created and configured an empty database somewhere. Only MySQL and PostgreSQL databases are supported.
Ensure you have a MySQL or PostgreSQL database co-located with the CodeTogether Locator. Proceed to login into your database server, and create the database and user for CodeTogether locator-central mode.
Substitute ctdbuser and ctdbpassword below with a username and password of your choice. The following commands illustrate the process with a MySQL database.
$ mysql -uroot -p -h 127.0.0.1
$ CREATE DATABASE codetogether;
$ CREATE USER 'ctdbuser'@'%' IDENTIFIED BY 'ctdbpassword';
$ GRANT ALL PRIVILEGES ON codetogether.* TO 'ctdbuser'@'%';
$ FLUSH PRIVILEGES;
$ exit
To secure CodeTogether, you can add a secret that contains your TLS (Transport Layer Security) private key and certificate:
$ kubectl create secret tls codetogether-tls --key <your-private-key-filename> --cert <your-certificate-filename>By default, CodeTogether A/V feature is enabled. You can change this at any time in your customized codetogether-values.yaml file to turn off Audio/Video in CodeTogether.
If you want to use CodeTogether A/V feature, please ensure that 10000/udp and 4443/tcp are available/opened in your network.
To set the value for av.serverIP, you can consider 3 scenarios:
- If the ports are exposed on the same IP address as
server.url, you can leaveav.serverIPvalue set toauto. - If the server name provided by
server.urlis not DNS resolvable - for instance, like being in your home network - you must setav.serverIPto that private IP. - If you are mapping ports 10000/udp and 4443/tcp to a different IP other than the server specified by
server.url, you may need to setav.serverIPto that IP.
Note: CodeTogether will not start if it cannot correctly determine the provided av.serverIP setting.
You can find CodeTogether usage metrics at:
https://<your-codetogether-server-fqdn>/dashboardIf you did not set dashboard.enabled to true, then the CodeTogether container will generate a random password for you and it will be printed in the pod logs:
2021-09-27 22:10 [INFO] This Edge server's metrics dashboard can be accessed at https://<your-codetogether-server-fqdn>/dashboard
with user: <userName>
using a temporary password: <randomGeneratedPassword>
Use CT_DASHBOARD_USER and CT_DASHBOARD_PASSWORD to set explicit values for this deployment.
To avoid having some sensitive data specified in the values.yaml file directly, you can create you own Kubernetes Secrets. Below is an example of a Secret that can be used as a template:
apiVersion: v1
kind: Secret
metadata:
annotations:
# Caution: please change the release name to match the one used during CodeTogether chart installation
meta.helm.sh/release-name: codetogether
meta.helm.sh/release-namespace: default
labels:
app.kubernetes.io/managed-by: Helm
name: mysecret
type: Opaque
data:
# for providing dasboard.username value (base64 encoded)
username: bXktZGFzaGJvYXJkLXVzZXJuYW1l
# for providing dashboard.password value (base64 encoded)
password: bXktZGFzaGJvYXJkLXBhc3N3b3Jk
# for providing proxy.uri value (base64 encoded)
proxy-uri: CXVtZGFzaGJvYXJkLXBhc3N3b3Jk
Once you create a file based on the template above, you can create a Secret by executing the following command:
kubectl apply -f mysecret.yaml
Add our CodeTogether repository to your Helm environment and pull our chart:
$ helm repo add genuitec https://genuitec.github.io/CodeTogether/helm/$ helm repo list
NAME URL
genuitec https://genuitec.github.io/CodeTogether/helm/$ helm repo update$ helm pull genuitec/codetogether --untar$ ls codetogether/
Chart.yaml LICENSE README.md templates values.yamlAs you already know, in Helm you can specify a parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install codetogether \
--set service.port=8080 \
./codetogetherHowever, we strongly recommend to create your own YAML file from the provided values.yaml sample file packaged within the chart in order to specify all the actual CodeTogether settings from there - such as your license data, server URL, hostname, etc. Once you have created your own codetogether-values.yaml file, then you could check for any possible configuration mistakes without actually deploying CodeTogether yet through the --dry-run and/or --debug flags:
$ helm install --dry-run --debug codetogether -f codetogether-values.yaml ./codetogetherIf the Chart configuration looks good from the above ouput, then you can deploy CodeTogether by running:
$ helm install codetogether -f codetogether-values.yaml ./codetogether$ helm list
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
codetogether ct 1 2022-01-31 10:45:28.963225621 -0600 CST deployed codetogether-1.4.0 2022.1.0If you want to see CodeTogether ingress entry points, you could run:
$ kubectl get ingress
NAME CLASS HOSTS ADDRESS PORTS AGE
codetogether <none> <codetogether-server-url> <ip-address> 80, 443 5m1sTo deploy newer releases, you can rollout a new revision (upgrade) for CodeTogether by downloading the updated Chart and then running:
$ helm repo update
$ helm pull genuitec/codetogether --untar
$ helm upgrade codetogether -f codetogether-values.yaml ./codetogetherThrough Helm you can see the revision history. For instance:
$ helm history codetogether
REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION
1 Mon Nov 29 17:52:27 2021 superseded codetogether-1.2.0 5.0.1 Install complete
2 Mon Jan 31 10:51:40 2022 deployed codetogether-1.4.0 2022.1.0 Upgrade complete$ helm uninstall codetogether