Skip to content

2. Requirements

Jump to bottom
Alex Tzortzis edited this page Jul 11, 2024 · 4 revisions

Setup deployment environment.

Install the microk8s system. This requires:

  • An Ubuntu 22.04 LTS, 20.04 LTS, 18.04 LTS or 16.04 LTS environment to run the commands (or another operating system which supports snapd - see the snapd documentation)
  • At least 540MB of memory, but to accommodate workloads, it is recommended a system with at least 20G of disk space and 4G of memory.
  • An internet connection

See more details regarding its configuration in the Prerequisites section

Request dataspace certificates

You need to become a participant in a dataspace as well as create your connector credentials in the Εnershare (or TSG Playground) dataspace. This is important to acquire the necessary certificate files and keys, as well as connector/partificant IDs (used in is secrets and values.yaml respectively).

  1. Create an account at the Enershare Identity Provider
  2. Go to the sub-tab Participants within the Management tab and request a Participant certificate via the button at the bottom of the page. You can choose your own participant ID, our suggestion is to use an identifier in the form of urn:ids:enershare:participants:ORGANISATION_NAME (where spaces can be replaced with hypens). You can either choose to create a private key and certificate signing request via the OpenSSL CLI or use the form under Create private key in browser. When using the form to generate the private key, ensure you download it, since it won't be stored anywhere by default.
  3. Go to the sub-tab Connectors withing the Management tab and request a Connector certificate via the button at the bottom of the page. The process is similar to the Participant certificate, but it requires a participant certificate. For the connector ID, our suggestion is to use an identifier in the form of urn:ids:enershare:connectors:ORGANISATION_NAME:CONNECTOR_NAME (where spaces can be replaced with hyphens). The connector name can be a human readable name for the connector.

At the end of this step, a participant and connector (with appropriate IDs) should be registered and the following files should be place in the directory of your connector:

├── cachain.crt     # certificate authority key
├── component.crt   # connector id certificate
├── component.key   # connector id key
├── participant.crt # participant/organization id certificate
└── participant.key # participant/organization id key

Send a message to Maarten and Willem, or ask during one of the calls, to activate the certificates.

SwaggerHub (Optional)

(For provider connectors) you need to have uploaded your API's documentation in SwaggerHub, when deploying APIs through the connector. See more details regarding its use in the Deployment section

Note: As of version 2.3.1 of the OpenAPI data app (image docker.nexus.dataspac.es/data-apps/openapi-data-app:2.3.1), it is no longer necessery to add your openAPI description to Swaggerhub for the connector to find your app. In values.yaml file, at both places where the openApiBaseUrl is allowed (on the root config of the data app and per agent) now also openApiMapping is supported. The structure is similar to backendUrlMapping, so per version the full URL of the OpenAPI document can be provided, e.g.:

openApiMapping:
  ${api-version}: http://path_to_api_description_json
versions: 
  - ${api-version}
Clone this wiki locally