This repository contains an application that talks to the CNS Dapr Sidecar, written in Node.js and using the Dapr SDK. The application is used in conjunction with CNS Dapr and it is assumed this is already installed and running (See the CNS Dapr repository for details).
When running, the application monitors cp:kubecns.control.v1:provider connections and installs or uninstalls applications based upon the properties of those connections.
To install or update the application, you should fetch the latest version from this Git repository. To do that, you may either download and unpack the repo zip file, or clone the repo using:
git clone https://github.com/cnscp/cns-kube.gitEither method should get you a copy of the latest version. It is recommended (but not compulsory) to place the repo in the ~/cns-kube project directory. Go to the project directory and install Node.js dependancies with:
npm installYour application should now be ready to rock.
Once installed, run the application locally with:
npm run start:dapr- NOTE:
daprmust be installed and running on your local machine for this command to work. If you want just the node server, usenpm run start
To shut down the application, hit ctrl-c.
The CNS Kube uses the following environment variables to configure itself:
| Name | Description | Default |
|---|---|---|
| CNS_CONTEXT | CNS Broker context | Must be set |
| CNS_DAPR | CNS Dapr application | 'cns-dapr' |
| CNS_DAPR_HOST | CNS Dapr host | 'localhost' |
| CNS_DAPR_PORT | CNS Dapr port | '3500' |
| CNS_PUBSUB | CNS Dapr PUBSUB component | 'cns-pubsub' |
| CNS_SERVER_HOST | CNS Kube server host | 'localhost' |
| CNS_SERVER_PORT | CNS Kube server port | '3001' |
Alternatively, variables can be stored in a .env file in the project directory.
| Property | Role | Description |
|---|---|---|
| action | Client | Action to perform |
| installer | Client | Installer you wish to use |
| namespace | Client | Namespace to install the application |
| releaseName | Client | Name of the Helm release |
| chartName | Client | Name of the Helm chart |
| helmValuesJSON | Client | Values for Helm as JSON string |
| repoUrl | Client | URL of the application repository |
| contextID | Client | CNS Broker context |
| contextToken | Client | CNS Broker token |
| interfaceUrl | Server | User Interface URL or blank for none |
| interfaceMode | Server | Rendering mode of UI, either 'embed' or 'tab' |
| status | Server | Status of the last action performed |
| Action | Description |
|---|---|
| apply | Tell the installer to add the application |
| applied | Set when application successfully installed |
| remove | Tell the installer to remove the application |
| removed | Set when application successfully removed |
| error | Action caused an error |
| Installer | Description |
|---|---|
| helm | Use Helm as application installer |
| kubectl | NYI |
| Name | Description | Default |
|---|---|---|
| HELM_BINARY_PATH | Path to Helm binary | Must be set |
| KTUNNEL_ENABLED_KEY | The helm values.yaml key to enable ktunnel | ktunnel.enabled |
| KTUNNEL_PORT_KEY | The helm values.yaml key to set which port to tunnel | service.port |
| KTUNNEL_ID_KEY | The helm values.yaml file to set the tunnel ID | ktunnel.id |
| INTERFACE_HOST | The ingress host for the tunneled application | ibb.staging.padi.io |
| KTUNNEL_DEFAULT_PORT | The default port to tunnel | 8080 |
NYI
| Status | Description |
|---|---|
| pending | Application awaiting deployment |
| deployed | Application was successfully deployed |
| failed | Application failed to deploy |
See LICENSE.md.
See COPYRIGHT.md.