Swiftpack.co - Package - IBM-Swift/CloudEnvironment

Kitura

APIDoc Build Status - Master macOS Linux Apache 2 Slack Status

CloudEnvironment

CloudEnvironment (formerly known as CloudConfiguration) is a convenience Swift package for accessing environment variables mapped to JSON objects from various Cloud computing environments, such as, but not limited to, Cloud Foundry and Kubernetes.

For example, to obtain the credentials for accessing a Cloudant database, you need to parse the VCAP_SERVICES environment variable when running in Cloud Foundry, while to obtain the same credentials when running in Kubernetes, you may need to parse an environment variable named CLOUDANT_CREDENTIALS. In other words, the path for obtaining certain environment values may differ from one cloud environment to another. By leveraging this package, you can make your Swift application environment-agnostic when it comes to obtaining such values. Using CloudEnvironment allows you to abstract these low-level details from your application's source code.

Swift version

The latest version of CloudEnvironment works with 4.0 and newer versions of the Swift binaries. You can download Swift binaries by following this link.

Abstraction and supported search pattern types

This package allows you to define a lookup key that your Swift application can leverage when searching for its corresponding value. This abstraction decouples your application from the actual name used for the environment variable you are looking for. For example, if you created a Cloudant service named my-awesome-cloudant-db, you don't have to use this name as the key in your Swift code to obtain its credentials. Instead, you can define a lookup key, say cloudant-credentials and map it to the actual service name, my-awesome-cloudant-db.

This library also allows you to define an array of search patterns for looking up a JSON object which is mapped to an environment variable, such as service credentials. Each element in the search patterns array will be executed until the variable is found. CloudEnvironment supports searching for values using the following three search pattern types:

  • cloudfoundry - Allows you to search for a value in Cloud Foundry's services environment variable (i.e. VCAP_SERVICES).
  • env - Allows you to search for a value mapped to an environment variable.
  • file - Allows you to search for a value in a JSON file.

You specify lookup keys and search patterns in a file named mappings.json. This file must exist in a config folder under the root folder of your Swift project. The following shows an example of a mappings.json file:

{
    "cloudant-credentials": {
        "credentials": {
            "searchPatterns": [
                "cloudfoundry:my-awesome-cloudant-db",
                "env:my_awesome_cloudant_db_credentials",
                "file:localdev/my-awesome-cloudant-db-credentials.json"
            ]
        }
    },
    "object-storage-credentials": {
        "credentials": {
            "searchPatterns": [
                "cloudfoundry:my-awesome-object-storage",
                "env:my_awesome_object_storage_credentials",
                "file:localdev/my-awesome-object-storage-credentials.json"
            ]
        }
    }
}

In the example above, cloudant-credentials and object-storage-credentials are the lookup keys your Swift application should use to look up the corresponding credentials. Please note that the path next to the file search pattern must be relative to the root folder of your Swift application.

Usage

Add dependencies

Add the CloudEnvironment package to the dependencies within your application’s Package.swift file. Substitute "x.x.x" with the latest CloudEnvironment release.

.package(url: "https://github.com/IBM-Swift/CloudEnvironment.git", from: "x.x.x")

Add CloudEnvironment to your target's dependencies:

.target(name: "example", dependencies: ["CloudEnvironment"]),

Once the Package.swift file of your application has been updated, import the CloudEnvironment modules and initialize an instance of CloudEnvironment:

import CloudEnvironment

let cloudEnv = CloudEnv()

Once you have a cloudEnv instance you can use it to query the credentials for one of the supported services, such as, Cloudant or ObjectStorage, as shown below this will return the credentials associated with that service:

let cloudantCredentials = cloudEnv.getCloudantCredentials(name: "cloudant-credentials")
// cloudantCredentials.username, cloudantCredentials.password, cloudantCredentials.url, etc.
let objStorageCredentials = cloudEnv.getObjectStorageCredentials(name: "object-storage-credentials")
// objStorageCredentials.username, objStorageCredentials.password, objStorageCredentials.projectID, etc.

let service1Credentials = cloudEnv.getDictionary("service1-credentials")
let service1CredentialsStr = cloudEnv.getString("service1-credentials")

// Get a default PORT and URL
let port = cloudEnv.port
let url = cloudEnv.url

This library simplifies obtaining service credentials, as shown above. For details on the different elements (e.g. username, password, url, etc.) that make up a credentials set and accessor methods for service credentials, check out the API reference documentation.

Following the above approach your application can be implemented in a runtime-environment agnostic way, abstracting differences in environment variable management introduced by different Cloud computing environments.

Supported services

The following services are currently supported by this library. Therefore, you can obtain the service credentials for any of these services with minimum effort:

If you don't see listed above the service you intend to use in your Swift application, you can leverage the generic getDictionary(name: String) method to get the corresponding credentials:

import CloudEnvironment

let cloudEnv = CloudEnv()

if let credentials: [String:Any] = cloudEnv.getDictionary(name: "service1-credentials") {
  // You can now get the corresponding values from the dictionary
}

API documentation

For more information visit our API reference.

Community

We love to talk server-side Swift, and Kitura. Join our Slack to meet the team!

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Github

link
Stars: 10
Help us keep the lights on

Dependencies

Releases

9.1.0 - Jun 21, 2019

  • Add support for "Databases for PostgreSQL" (#60)

9.0.1 - Apr 4, 2019

  • Support Swift 5
  • Documentation improvements

9.0.0 - Aug 31, 2018

This release contains a credential change in the Push Notifications service, which previously used appSecret along with region and appGuid to authenticate with the service. The IAM-based credential set now uses apikey instead of appSecret to authenticate.

These credential changes are present in version 0.9.0+ of the Push Notifications SDK.

8.0.0 - Jun 21, 2018

This release accomplishes the following:

  • Watson Natural Language Understanding now uses the naming convention NaturalLanguageUnderstanding instead of the abbreviated NaturalLangUnderstanding.
  • Watson Conversation has been rebranded to Watson Assistant.
  • Watson Assistant and Watson Natural Language Understanding now use IAM API Key authentication. To use user/password authentication, please use version 7.1.0 or prior.

7.1.0 - Mar 14, 2018

What's new

Adds an additional API to retrieve HyperSecure DBaaS Credentials