There are known issues but this is a proof of concept and an experiment with Kitura and Watson capabilities
This scaffolded application provides a starting point for creating Swift applications running on Kitura.
This application has been generated with the following capabilities and services:
- CloudConfiguration
- Static web file serving
- Embedded metrics dashboard
- Docker files
- Bluemix cloud deployment
- Cloudant
- Watson Conversation
This application includes a public directory in the root of the project. The contents of this directory will be served as static content using the built-in Kitura StaticFileServer module.
This content is hosted on /. For example, if you want to view public/myfile.html and the application is hosted at https://localhost:8080, go to https://localhost:8080/myfile.html.
This application uses the SwiftMetrics package to gather application and system metrics.
These metrics can be viewed in an embedded dashboard on /swiftmetrics-dash. The dashboard displays various system and application metrics, including CPU, memory usage, HTTP response metrics and more.
The application includes the following files for Docker support:
.dockerignoreDockerfileDockerfile-tools
The .dockerignore file contains the files/directories that should not be included in the built docker image. By default this file contains the Dockerfile and Dockerfile-tools. It can be modified as required.
The Dockerfile defines the specification of the default docker image for running the application. This image can be used to run the application.
The Dockerfile-tools is a docker specification file similar to the Dockerfile, except it includes the tools required for compiling the application. This image can be used to compile the application.
Details on how to build the docker images, compile and run the application within the docker image can be found in the Run section below.
Your application has a set of Bluemix cloud deployment configuration files defined to support deploying your application to Bluemix:
manifest.yml.bluemix/toolchain.yml.bluemix/pipeline.yml
The manifest.yml defines options which are passed to the Cloud Foundry cf push command during application deployment.
IBM Bluemix DevOps service provides toolchains as a set of tool integrations that support development, deployment, and operations tasks inside Bluemix. The "Create Toolchain" button creates a DevOps toolchain and acts as a single-click deploy to Bluemix including provisioning all required services.
This application uses the Kitura-CouchDB package, which allows Kitura applications to interact with a Cloudant or CouchDB database.
CouchDB speaks JSON natively and supports binary for all your data storage needs.
Boilerplate code for creating a client object for the Kitura-CouchDB API is included inside Sources/Application/Application.swift as an internal variable available for use anywhere in the Application module.
The connection details for this client are loaded by the configuration code and are passed to the Kitura-CouchDB client in the boilerplate code.
This application uses the Watson Swift SDK package, which allows Kitura applications to build Watson-powered applications, specifically in this case the IBM Watson Conversation service.
With the IBM Watson Conversation service you can create cognitive agents--virtual agents that combine machine learning, natural language understanding, and integrated dialog scripting tools to build outstanding projects, such as a chat room with an integrated Watson chat bot.
Boilerplate code for creating a client object for the Watson Conversation API is included inside Sources/Application/Application.swift as an internal variable available for use anywhere in the Application module.
The connection details for this client are loaded by the configuration code and are passed to the Watson Conversation client in the boilerplate code.
More information about the Watson Conversation can be found in the README
Your application configuration information is stored in the config.json in the project root directory. This file is in the .gitignore to prevent sensitive information from being stored in git.
The connection information for any configured services, such as username, password and hostname, is stored in this file.
The application uses the CloudConfiguration package to read the connection and configuration information from the environment and this file.
If the application is running locally, it can connect to Bluemix services using unbound credentials read from this file. If you need to create unbound credentials you can do so from the Bluemix web console (example), or using the CloudFoundry CLI cf create-service-key command.
When you push your application to Bluemix, these values are no longer used, instead Bluemix automatically connects to bound services using environment variables.
To build and run the application:
swift build.build/debug/text-bot
NOTE: On macOS you will need to add options to the swift build command: swift build -Xlinker -lc++
To build the two docker images, run the following commands from the root directory of the project:
docker build -t myapp-run .docker build -t myapp-build -f Dockerfile-tools .You may customize the names of these images by specifying a different value after the-toption.
To compile the application using the tools docker image, run:
docker run -v $PWD:/root/project -w /root/project myapp-build /root/utils/tools-utils.sh build release
To run the application:
docker run -it -p 8080:8080 -v $PWD:/root/project -w /root/project myapp-run sh -c .build-ubuntu/release/text-bot
You can deploy your application to Bluemix using:
You can deploy the application to Bluemix using the CloudFoundry command-line:
- Install the Cloud Foundry command-line (https://docs.cloudfoundry.org/cf-cli/install-go-cli.html)
- Ensure all configured services have been provisioned
- Run
cf pushfrom the project root directory
The Cloud Foundry CLI will not provision the configured services for you, so you will need to do this manually using the Bluemix web console (example) or the CloudFoundry CLI (cf create-service command)[http://cli.cloudfoundry.org/en-US/cf/create-service.html]. The service names and types will need to match your configuration.
You can also set up a default Bluemix Toolchain to handle deploying your application to Bluemix. This is achieved by publishing your application to a publicly accessible github repository and using the "Create Toolchain" button below. In this case configured services will be automatically provisioned, once, during toolchain creation.
All generated content is available for use and modification under the permissive MIT License (see LICENSE file), with the exception of SwaggerUI which is licensed under an Apache-2.0 license (see NOTICES.txt file).
This project was generated with generator-swiftserver v2.1.0.