diff --git a/cloud-agent/client/typescript/package.json b/cloud-agent/client/typescript/package.json index 530dd6fc09..28ac1fbfcd 100644 --- a/cloud-agent/client/typescript/package.json +++ b/cloud-agent/client/typescript/package.json @@ -1,5 +1,5 @@ { - "name": "@hyperledger/cloud-agent-client-ts", + "name": "@hyperledger/identus-cloud-agent-client-ts", "version": "0.0.1", "description": "TypeScript OpenAPI client for Identus Cloud Agent", "author": "allain.magyar@iohk.io", diff --git a/cloud-agent/service/server/src/main/resources/application.conf b/cloud-agent/service/server/src/main/resources/application.conf index 1be6917b31..4e8a3be8e1 100644 --- a/cloud-agent/service/server/src/main/resources/application.conf +++ b/cloud-agent/service/server/src/main/resources/application.conf @@ -86,7 +86,7 @@ agent { port = 8085 port =${?AGENT_HTTP_PORT} } - publicEndpointUrl = "https://host.docker.internal:8080/prism-agent" + publicEndpointUrl = "https://host.docker.internal:8080/cloud-agent" publicEndpointUrl = ${?REST_SERVICE_URL} } didCommEndpoint { diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/MainApp.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/MainApp.scala index 3fd30afe4c..d334e3da4c 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/MainApp.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/MainApp.scala @@ -108,12 +108,19 @@ object MainApp extends ZIOAppDefault { val app = for { _ <- Console .printLine(s""" - |██████╗ ██████╗ ██╗███████╗███╗ ███╗ - |██╔══██╗██╔══██╗██║██╔════╝████╗ ████║ - |██████╔╝██████╔╝██║███████╗██╔████╔██║ - |██╔═══╝ ██╔══██╗██║╚════██║██║╚██╔╝██║ - |██║ ██║ ██║██║███████║██║ ╚═╝ ██║ - |╚═╝ ╚═╝ ╚═╝╚═╝╚══════╝╚═╝ ╚═╝ + |██╗██████╗ ███████╗███╗ ██╗████████╗██╗ ██╗███████╗ + |██║██╔══██╗██╔════╝████╗ ██║╚══██╔══╝██║ ██║██╔════╝ + |██║██║ ██║█████╗ ██╔██╗ ██║ ██║ ██║ ██║███████╗ + |██║██║ ██║██╔══╝ ██║╚██╗██║ ██║ ██║ ██║╚════██║ + |██║██████╔╝███████╗██║ ╚████║ ██║ ╚██████╔╝███████║ + |╚═╝╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚═════╝ ╚══════╝ + | + | ██████╗██╗ ██████╗ ██╗ ██╗██████╗ + |██╔════╝██║ ██╔═══██╗██║ ██║██╔══██╗ + |██║ ██║ ██║ ██║██║ ██║██║ ██║ + |██║ ██║ ██║ ██║██║ ██║██║ ██║ + |╚██████╗███████╗╚██████╔╝╚██████╔╝██████╔╝ + | ╚═════╝╚══════╝ ╚═════╝ ╚═════╝ ╚═════╝ | | █████╗ ██████╗ ███████╗███╗ ██╗████████╗ |██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝ @@ -122,7 +129,7 @@ object MainApp extends ZIOAppDefault { |██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║ |╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ | - |version: ${BuildInfo.version} + |version: ${buildinfo.BuildInfo.version} | |""".stripMargin) .ignore diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala index fa72fabd34..4da38db95f 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala @@ -57,11 +57,11 @@ object DocModels { .openapi("3.0.3") .info( Info( - title = "Open Enterprise Agent API Reference", + title = "Identus Cloud Agent API Reference", version = "1.0", // Will be replaced dynamically by 'Tapir2StaticOAS' summary = None, description = Some(""" - |The Open Enterprise Agent API facilitates the integration and management of self-sovereign identity capabilities within applications. + |The Identus Cloud Agent API facilitates the integration and management of self-sovereign identity capabilities within applications. |It supports DID (Decentralized Identifiers) management, verifiable credential exchange, and secure messaging based on DIDComm standards. |The API is designed to be interoperable with various blockchain and DLT (Distributed Ledger Technology) platforms, ensuring wide compatibility and flexibility. |Key features include connection management, credential issuance and verification, and secure, privacy-preserving communication between entities. @@ -81,11 +81,14 @@ object DocModels { ) .servers( List( - Server(url = "http://localhost:8085", description = Some("Local Prism Agent")), - Server(url = "http://localhost/prism-agent", description = Some("Local Prism Agent with APISIX proxy")), + Server(url = "http://localhost:8085", description = Some("The local instance of the Cloud Agent")), Server( - url = "https://k8s-dev.atalaprism.io/prism-agent", - description = Some("Prism Agent on the Staging Environment") + url = "http://localhost/cloud-agent", + description = Some("The local instance of the Cloud Agent behind the APISIX proxy") + ), + Server( + url = "https://k8s-dev.atalaprism.io/cloud-agent", + description = Some("The Cloud Agent in the Staging Environment") ), ) ) diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/connect/controller/http/ConnectionsPage.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/connect/controller/http/ConnectionsPage.scala index cddb14d73c..2847599f50 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/connect/controller/http/ConnectionsPage.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/connect/controller/http/ConnectionsPage.scala @@ -57,7 +57,7 @@ object ConnectionsPage { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/connections?offset=10&limit=10" + example = "/cloud-agent/connections?offset=10&limit=10" ) object pageOf @@ -70,14 +70,14 @@ object ConnectionsPage { extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/connections?offset=20&limit=10" + example = "/cloud-agent/connections?offset=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/connections?offset=0&limit=10" + example = "/cloud-agent/connections?offset=0&limit=10" ) } diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponse.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponse.scala index 72d03d34bb..7884216feb 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponse.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponse.scala @@ -67,7 +67,7 @@ object EntityResponse { object self extends Annotation[String]( description = "The `self` link of the entity.", - example = "http://localhost:8080/prism-agent/iam/entities/00000000-0000-0000-0000-000000000000" + example = "http://localhost:8080/cloud-agent/iam/entities/00000000-0000-0000-0000-000000000000" ) object id @@ -103,7 +103,7 @@ object EntityResponse { val Example = EntityResponse( kind = "Entity", - self = "/prism-agent/iam/entities/00000000-0000-0000-0000-000000000000", + self = "/cloud-agent/iam/entities/00000000-0000-0000-0000-000000000000", id = UUID.fromString("00000000-0000-0000-0000-000000000000"), name = "John Doe", walletId = UUID.fromString("00000000-0000-0000-0000-000000000000"), diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponsePage.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponsePage.scala index 63bfae19da..cdf022c0b0 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponsePage.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/iam/entity/http/model/EntityResponsePage.scala @@ -69,27 +69,27 @@ object EntityResponsePage { object self extends Annotation[String]( description = "A string field containing the URL of the current API endpoint", - example = "/prism-agent/schema-registry/schemas?skip=10&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=10&limit=10" ) object pageOf extends Annotation[String]( description = "A string field indicating the type of resource that the contents field contains", - example = "/prism-agent/schema-registry/schemas" + example = "/cloud-agent/schema-registry/schemas" ) object next extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. " + "If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/schema-registry/schemas?skip=20&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. " + "If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/schema-registry/schemas?skip=0&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=0&limit=10" ) } diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/CreateIssueCredentialRecordRequest.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/CreateIssueCredentialRecordRequest.scala index 89b043b7a2..fa859c42f9 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/CreateIssueCredentialRecordRequest.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/CreateIssueCredentialRecordRequest.scala @@ -71,7 +71,7 @@ object CreateIssueCredentialRecordRequest { |Note that this parameter only applies when the offer is of type 'JWT'. |""".stripMargin, example = Some( - "https://agent-host.com/prism-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676/schema" + "https://agent-host.com/cloud-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676/schema" ) ) diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecordPage.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecordPage.scala index dfc3a94ab0..7db33c1f0c 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecordPage.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecordPage.scala @@ -70,27 +70,27 @@ object IssueCredentialRecordPage { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/issue-credentials/records?offset=10&limit=10" + example = "/cloud-agent/issue-credentials/records?offset=10&limit=10" ) object pageOf extends Annotation[String]( description = "A string field indicating the type of resource that the contents field contains.", - example = "/prism-agent/issue-credentials/records" + example = "/cloud-agent/issue-credentials/records" ) object next extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/issue-credentials/records?offset=20&limit=10" + example = "/cloud-agent/issue-credentials/records?offset=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/issue-credentials/records?offset=0&limit=10" + example = "/cloud-agent/issue-credentials/records?offset=0&limit=10" ) } diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponse.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponse.scala index bb2c470672..23a65d25e9 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponse.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponse.scala @@ -135,7 +135,7 @@ object CredentialDefinitionResponse { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/credential-definition-registry/schemas/0527aea1-d131-3948-a34d-03af39aba8b4" + example = "/cloud-agent/credential-definition-registry/schemas/0527aea1-d131-3948-a34d-03af39aba8b4" ) object kind @@ -187,7 +187,7 @@ object CredentialDefinitionResponse { extends Annotation[Option[String]]( description = "The unique identifier of the schema used for this credential definition.", example = - Some("https://agent-host.com/prism-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676") + Some("https://agent-host.com/cloud-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676") ) object authored diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponsePage.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponsePage.scala index e1502c1213..789c810fb6 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponsePage.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialdefinition/http/CredentialDefinitionResponsePage.scala @@ -70,27 +70,27 @@ object CredentialDefinitionResponsePage { object self extends Annotation[String]( description = "A string field containing the URL of the current API endpoint", - example = "/prism-agent/credential-definition-registry/definitions?skip=10&limit=10" + example = "/cloud-agent/credential-definition-registry/definitions?skip=10&limit=10" ) object pageOf extends Annotation[String]( description = "A string field indicating the type of resource that the contents field contains", - example = "/prism-agent/credential-definition-registry/definitions" + example = "/cloud-agent/credential-definition-registry/definitions" ) object next extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. " + "If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/credential-definition-registry/definitions?skip=20&limit=10" + example = "/cloud-agent/credential-definition-registry/definitions?skip=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. " + "If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/credential-definition-registry/definitions?skip=0&limit=10" + example = "/cloud-agent/credential-definition-registry/definitions?skip=0&limit=10" ) } } diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponse.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponse.scala index ee53873913..1d0657cbdf 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponse.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponse.scala @@ -127,7 +127,7 @@ object CredentialSchemaResponse { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/schema-registry/schemas/0527aea1-d131-3948-a34d-03af39aba8b4" + example = "/cloud-agent/schema-registry/schemas/0527aea1-d131-3948-a34d-03af39aba8b4" ) object kind extends Annotation[String]( diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponsePage.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponsePage.scala index f54d7e8106..b5fc076b7a 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponsePage.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/CredentialSchemaResponsePage.scala @@ -64,27 +64,27 @@ object CredentialSchemaResponsePage { object self extends Annotation[String]( description = "A string field containing the URL of the current API endpoint", - example = "/prism-agent/schema-registry/schemas?skip=10&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=10&limit=10" ) object pageOf extends Annotation[String]( description = "A string field indicating the type of resource that the contents field contains", - example = "/prism-agent/schema-registry/schemas" + example = "/cloud-agent/schema-registry/schemas" ) object next extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. " + "If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/schema-registry/schemas?skip=20&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. " + "If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/schema-registry/schemas?skip=0&limit=10" + example = "/cloud-agent/schema-registry/schemas?skip=0&limit=10" ) } } diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/VerificationPolicyResponse.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/VerificationPolicyResponse.scala index df234f3098..80f96eea06 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/VerificationPolicyResponse.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/pollux/credentialschema/http/VerificationPolicyResponse.scala @@ -174,7 +174,7 @@ object VerificationPolicyResponse { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/verification/policies/0527aea1-d131-3948-a34d-03af39aba8b4" + example = "/cloud-agent/verification/policies/0527aea1-d131-3948-a34d-03af39aba8b4" ) object kind @@ -229,7 +229,7 @@ object VerificationPolicyResponse { } val example = VerificationPolicyResponse( - self = "/prism-agent/verification/policies", + self = "/cloud-agent/verification/policies", kind = "VerificationPolicy", id = UUID.fromString("0527aea1-d131-3948-a34d-03af39aba8b4"), nonce = 0, @@ -286,7 +286,7 @@ object VerificationPolicyResponsePage { object self extends Annotation[String]( description = "The URL that uniquely identifies the resource being returned in the response.", - example = "/prism-agent/verification/policies?name=Trusted&offset=0&limit=10" + example = "/cloud-agent/verification/policies?name=Trusted&offset=0&limit=10" ) object kind @@ -298,21 +298,21 @@ object VerificationPolicyResponsePage { object pageOf extends Annotation[String]( description = "A string field indicating the type of resource that the contents field contains", - example = "/prism-agent/verification/policies" + example = "/cloud-agent/verification/policies" ) object next extends Annotation[String]( description = "An optional string field containing the URL of the next page of results. " + "If the API response does not contain any more pages, this field should be set to None.", - example = "/prism-agent/verification/policies?skip=20&limit=10" + example = "/cloud-agent/verification/policies?skip=20&limit=10" ) object previous extends Annotation[String]( description = "An optional string field containing the URL of the previous page of results. " + "If the API response is the first page of results, this field should be set to None.", - example = "/prism-agent/verification/policies?skip=0&limit=10" + example = "/cloud-agent/verification/policies?skip=0&limit=10" ) object contents extends Annotation[Seq[VerificationPolicyResponse]]( @@ -323,11 +323,11 @@ object VerificationPolicyResponsePage { } val example = VerificationPolicyResponsePage( - self = "/prism-agent/verification/policies?name=Trusted&offset=0&limit=10", + self = "/cloud-agent/verification/policies?name=Trusted&offset=0&limit=10", kind = "VerificationPolicyPage", - pageOf = "/prism-agent/verification/policies", - next = Some("/prism-agent/verification/policies?skip=20&limit=10"), - previous = Some("/prism-agent/verification/policies?skip=0&limit=10"), + pageOf = "/cloud-agent/verification/policies", + next = Some("/cloud-agent/verification/policies?skip=20&limit=10"), + previous = Some("/cloud-agent/verification/policies?skip=0&limit=10"), contents = List(VerificationPolicyResponse.example) ) } diff --git a/docs/docusaurus/connections/connection.md b/docs/docusaurus/connections/connection.md index f33368bb89..488295856d 100644 --- a/docs/docusaurus/connections/connection.md +++ b/docs/docusaurus/connections/connection.md @@ -85,7 +85,7 @@ The following example demonstrates how you could use two Cloud Agent APIs to set ```shell curl -X 'POST' \ - 'http://localhost:8080/prism-agent/connections' \ + 'http://localhost:8080/cloud-agent/connections' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ -d '{ "label": "Connect with Alice" }' | jq @@ -114,7 +114,7 @@ Example response: Replace `{RAW_INVITATION}` with the value of the '_oob' query string parameter from the invitation URL above ```shell curl -X 'POST' \ - 'http://localhost:8090/prism-agent/connection-invitations' \ + 'http://localhost:8090/cloud-agent/connection-invitations' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ -d '{ "invitation": "{RAW_INVITATION}" }' | jq @@ -143,7 +143,7 @@ Example response: ### Invitee retrieves the list of connections ```shell -curl -X 'GET' 'http://localhost:8090/prism-agent/connections' \ +curl -X 'GET' 'http://localhost:8090/cloud-agent/connections' \ -H "apikey: $API_KEY" | jq ``` @@ -176,7 +176,7 @@ Example output: ### Inviter retrieves the list of connections ```shell -curl -X 'GET' 'http://localhost:8080/prism-agent/connections' \ +curl -X 'GET' 'http://localhost:8080/cloud-agent/connections' \ -H "apikey: $API_KEY" | jq ``` diff --git a/docs/docusaurus/credentialdefinition/create.md b/docs/docusaurus/credentialdefinition/create.md index f2a39bcb25..653e7eb6fc 100644 --- a/docs/docusaurus/credentialdefinition/create.md +++ b/docs/docusaurus/credentialdefinition/create.md @@ -23,7 +23,7 @@ Here's a sample content of the credential definition: "version": "1.0.0", "tag": "Licence", "author": "{{ISSUER_DID_SHORT}}", - "schemaId": "http://host.docker.internal:8080/prism-agent/schema-registry/schemas/{{SCHEMA_ID}}", + "schemaId": "http://host.docker.internal:8080/cloud-agent/schema-registry/schemas/{{SCHEMA_ID}}", "signatureType": "CL", "supportRevocation": true } @@ -46,7 +46,7 @@ Please note: The `author` field value should align with the short form of a PRIS "version": "1.0.0", "tag": "Licence", "author": "{{ISSUER_DID_SHORT}}", - "schemaId": "http://host.docker.internal:8080/prism-agent/schema-registry/schemas/{{SCHEMA_ID}}", + "schemaId": "http://host.docker.internal:8080/cloud-agent/schema-registry/schemas/{{SCHEMA_ID}}", "signatureType": "CL", "supportRevocation": true } @@ -70,7 +70,7 @@ curl -X 'POST' \ "version": "1.0.0", "tag": "Licence", "author": "{{ISSUER_DID_SHORT}}", - "schemaId": "http://host.docker.internal:8080/prism-agent/schema-registry/schemas/{{SCHEMA_ID}}", + "schemaId": "http://host.docker.internal:8080/cloud-agent/schema-registry/schemas/{{SCHEMA_ID}}", "signatureType": "CL", "supportRevocation": true } @@ -89,7 +89,7 @@ A potential response could be: "tag": "Licence", "author": "did:prism:4a5b5cf0a513e83b598bbea25cd6196746747f361a73ef77068268bc9bd732ff", "authored": "2023-03-14T14:41:46.713943Z", - "schemaId": "http://host.docker.internal:8080/prism-agent/schema-registry/schemas/{{SCHEMA_ID}}", + "schemaId": "http://host.docker.internal:8080/cloud-agent/schema-registry/schemas/{{SCHEMA_ID}}", "signatureType": "CL", "supportRevocation": true, "kind": "CredentialDefinition", @@ -123,7 +123,7 @@ You should receive a response containing the JSON object representing the creden "tag": "Licence", "author": "did:prism:4a5b5cf0a513e83b598bbea25cd6196746747f361a73ef77068268bc9bd732ff", "authored": "2023-03-14T14:41:46.713943Z", - "schemaId": "http://host.docker.internal:8080/prism-agent/schema-registry/schemas/{{SCHEMA_ID}}", + "schemaId": "http://host.docker.internal:8080/cloud-agent/schema-registry/schemas/{{SCHEMA_ID}}", "signatureType": "CL", "supportRevocation": true, "kind": "CredentialDefinition", diff --git a/docs/docusaurus/credentials/issue.md b/docs/docusaurus/credentials/issue.md index 6ce39431d8..936e038c78 100644 --- a/docs/docusaurus/credentials/issue.md +++ b/docs/docusaurus/credentials/issue.md @@ -87,7 +87,7 @@ To do this, make a `POST` request to the [`/issue-credentials/credential-offers` The Cloud Agent must be able to dereference the specified URL (i.e. fetch the VC schema content from it), in order to validate the provided claims against it. When not specified, the claims fields is not validated and can be any valid JSON object. Please refer to the [Create VC schema](../schemas/create.md) doc for details on how to create a VC schema. -5. `credentialFormat`: The format of the credential that will be issued - `JWT` in this case. When not specified, the default value is `JWT`. +5. `credentialFormat`: The format of the credential that will be issued - `JWT` in this case. When not specified, the default value is `JWT`. :::note @@ -99,7 +99,7 @@ Once the request initiates, a new credential record for the issuer gets created ```shell # Issuer POST request to create a new credential offer curl -X 'POST' \ - 'http://localhost:8080/prism-agent/issue-credentials/credential-offers' \ + 'http://localhost:8080/cloud-agent/issue-credentials/credential-offers' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ @@ -115,7 +115,7 @@ curl -X 'POST' \ "credentialFormat": "JWT", "issuingDID": "did:prism:9f847f8bbb66c112f71d08ab39930d468ccbfe1e0e1d002be53d46c431212c26", "connectionId": "9d075518-f97e-4f11-9d10-d7348a7a0fda", - "schemaId": "http://localhost:8080/prism-agent/schema-registry/schemas/3f86a73f-5b78-39c7-af77-0c16123fa9c2" + "schemaId": "http://localhost:8080/cloud-agent/schema-registry/schemas/3f86a73f-5b78-39c7-af77-0c16123fa9c2" }' ``` @@ -136,7 +136,7 @@ Once the request initiates, a new credential record for the issuer gets created ```shell # Issuer POST request to create a new credential offer curl -X 'POST' \ - 'http://localhost:8080/prism-agent/issue-credentials/credential-offers' \ + 'http://localhost:8080/cloud-agent/issue-credentials/credential-offers' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ @@ -177,7 +177,7 @@ The Issuer can then use the [`/issue-credentials/records/{recordId}/issue-creden # make sure you have `issuer_record_id` extracted from created credential offer # and the record achieved `RequestReceived` state curl -X POST \ - "http://localhost:8080/prism-agent/issue-credentials/records/$issuer_record_id/issue-credential" \ + "http://localhost:8080/cloud-agent/issue-credentials/records/$issuer_record_id/issue-credential" \ -H "Content-Type: application/json" \ -H "apikey: $API_KEY" ``` @@ -215,7 +215,7 @@ This process is automatic for the Cloud Agent. You could check if a new credential offer is available using [`/issue-credentials/records`](/#tag/Issue-Credentials-Protocol/operation/getCredentialRecords) request and check for any records available in `OfferReceived` state: ```shell # Holder GET request to retrieve credential records -curl "http://localhost:8090/prism-agent/issue-credentials/records" \ +curl "http://localhost:8090/cloud-agent/issue-credentials/records" \ -H "Content-Type: application/json" \ -H "apikey: $API_KEY" ``` @@ -233,7 +233,7 @@ To accept the offer, the Holder can make a `POST` request to the [`/issue-creden ```shell # Holder POST request to accept the credential offer -curl -X POST "http://localhost:8090/prism-agent/issue-credentials/records/$holder_record_id/accept-offer" \ +curl -X POST "http://localhost:8090/cloud-agent/issue-credentials/records/$holder_record_id/accept-offer" \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ @@ -249,7 +249,7 @@ curl -X POST "http://localhost:8090/prism-agent/issue-credentials/records/$holde ```shell # Holder POST request to accept the credential offer -curl -X POST "http://localhost:8090/prism-agent/issue-credentials/records/$holder_record_id/accept-offer" \ +curl -X POST "http://localhost:8090/cloud-agent/issue-credentials/records/$holder_record_id/accept-offer" \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ diff --git a/docs/docusaurus/credentials/present-proof.md b/docs/docusaurus/credentials/present-proof.md index 47be894982..f479ffbdb9 100644 --- a/docs/docusaurus/credentials/present-proof.md +++ b/docs/docusaurus/credentials/present-proof.md @@ -13,8 +13,8 @@ The protocol provides endpoints for a Verifier to request new proof presentation The present proof protocol has two roles: -1. Verifier: A subject requesting a proof presentation by sending a request presentation message, then verifying the presentation. -2. Holder/Prover: A [subject](/docs/concepts/glossary#subject) that receives a [proof presentation](/docs/concepts/glossary#proof-presentation) request, prepares a proof, and sends it to the verifier by sending a proof presentation message. +1. Verifier: A subject requesting a proof presentation by sending a request presentation message, then verifying the presentation. +2. Holder/Prover: A [subject](/docs/concepts/glossary#subject) that receives a [proof presentation](/docs/concepts/glossary#proof-presentation) request, prepares a proof, and sends it to the verifier by sending a proof presentation message. ## Prerequisites @@ -37,12 +37,12 @@ The protocol consists of the following main parts: ## Endpoints -| Endpoint | Method | Description | Role | -| --- | --- | --- | --- | -| [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/requestPresentation) | POST | Creates and sends a new proof presentation request. | Verifier | -| [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/getAllPresentation) | GET | Retrieves the collection of all the existing presentation proof records - sent or received. | Verifier, Holder/Prover | -| [`/present-proof/presentations/{id}`](/agent-api/#tag/Present-Proof/operation/getPresentation) | GET | Retrieves a specific presentation proof record by `id`. | Verifier, Holder/Prover | -| [`/present-proof/presentations/{id}`](/agent-api/#tag/Present-Proof/operation/updatePresentation) | PATCH | Updates an existing presentation proof record to, e.g., accept the request on the Holder/Prover side or accept the presentation on the Verifier side. | Verifier, Holder/Prover | +| Endpoint | Method | Description | Role | +|---------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/requestPresentation) | POST | Creates and sends a new proof presentation request. | Verifier | +| [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/getAllPresentation) | GET | Retrieves the collection of all the existing presentation proof records - sent or received. | Verifier, Holder/Prover | +| [`/present-proof/presentations/{id}`](/agent-api/#tag/Present-Proof/operation/getPresentation) | GET | Retrieves a specific presentation proof record by `id`. | Verifier, Holder/Prover | +| [`/present-proof/presentations/{id}`](/agent-api/#tag/Present-Proof/operation/updatePresentation) | PATCH | Updates an existing presentation proof record to, e.g., accept the request on the Holder/Prover side or accept the presentation on the Verifier side. | Verifier, Holder/Prover | :::info For more detailed information, please, check the full [Cloud Agent API](/agent-api). @@ -64,10 +64,10 @@ To do this, he makes a `POST` request to the [`/present-proof/presentations`](/a ```bash -curl -X 'POST' 'http://localhost:8070/prism-agent/present-proof/presentations' \ +curl -X 'POST' 'http://localhost:8070/cloud-agent/present-proof/presentations' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ - -H "apikey: $API_KEY" \ + -H "apikey: $API_KEY" \ -d '{ "connectionId": "872ddfa9-4115-46c2-8a1b-22c24c7431d7", "proofs":[], @@ -82,10 +82,10 @@ curl -X 'POST' 'http://localhost:8070/prism-agent/present-proof/presentations' \ ```bash -curl -X 'POST' 'http://localhost:8070/prism-agent/present-proof/presentations' \ +curl -X 'POST' 'http://localhost:8070/cloud-agent/present-proof/presentations' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ - -H "apikey: $API_KEY" \ + -H "apikey: $API_KEY" \ -d '{ "connectionId": "872ddfa9-4115-46c2-8a1b-22c24c7431d7", "anoncredPresentationRequest": { @@ -132,9 +132,9 @@ Upon execution, a new presentation request record gets created with an initial s The Verifier can retrieve the list of presentation records by making a `GET` request to the [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/getAllPresentation) endpoint: ```bash -curl -X 'GET' 'http://localhost:8070/prism-agent/present-proof/presentations' \ +curl -X 'GET' 'http://localhost:8070/cloud-agent/present-proof/presentations' \ -H 'accept: application/json' \ - -H "apikey: $API_KEY" + -H "apikey: $API_KEY" ``` ### Accept presentation proof received from the Holder/prover @@ -143,7 +143,7 @@ Once the Holder/Prover has received a proof presentation request, he can accept The Verifier can then explicitly accept the specific verified proof presentation to change the record state to `PresentationAccepted` by making a `PATCH` request to the [`/present-proof/presentations/{id}`](/agent-api/#tag/Present-Proof/operation/updatePresentation) endpoint: ```bash -curl -X 'PATCH' 'http://localhost:8070/prism-agent/present-proof/presentations/{PRESENTATION_ID}' \ +curl -X 'PATCH' 'http://localhost:8070/cloud-agent/present-proof/presentations/{PRESENTATION_ID}' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ -d '{ @@ -170,7 +170,7 @@ This section describes the interactions available to the Holder/Prover with his The Holder/Prover can retrieve the list of presentation requests received by its Cloud Agent from different Verifiers making a `GET` request to the [`/present-proof/presentations`](/agent-api/#tag/Present-Proof/operation/getAllPresentation) endpoint: ```bash -curl -X 'GET' 'http://localhost:8090/prism-agent/present-proof/presentations' \ +curl -X 'GET' 'http://localhost:8090/cloud-agent/present-proof/presentations' \ -H 'accept: application/json' \ -H "apikey: $API_KEY" ``` @@ -181,7 +181,7 @@ The Holder/Prover can then accept a specific request, generate the proof, and se ```bash -curl -X 'PATCH' 'http://localhost:8090/prism-agent/present-proof/presentations/{PRESENTATION_ID}' \ +curl -X 'PATCH' 'http://localhost:8090/cloud-agent/present-proof/presentations/{PRESENTATION_ID}' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ -d '{ @@ -198,7 +198,7 @@ The Holder/Prover will have to provide the following information: ```bash -curl -X 'PATCH' 'http://localhost:8090/prism-agent/present-proof/presentations/{PRESENTATION_ID}' \ +curl -X 'PATCH' 'http://localhost:8090/cloud-agent/present-proof/presentations/{PRESENTATION_ID}' \ -H 'Content-Type: application/json' \ -H "apikey: $API_KEY" \ -d '{ @@ -224,7 +224,7 @@ curl -X 'PATCH' 'http://localhost:8090/prism-agent/present-proof/presentations/{ The Holder/Prover will have to provide the following information: 1. `presentationId`: The unique identifier of the presentation record to accept. 2. `anoncredPresentationRequest`: A list of credential unique identifier with the attribute and predicate the credential is answering for. - + The record state is updated to `PresentationPending` and processed by the Holder/Prover Cloud Agent. The agent will automatically generate the proof presentation, change the state to `PresentationGenerated`, and will eventually send it to the Verifier Agent, and change the state to `PresentationSent`. ```mermaid @@ -240,7 +240,7 @@ stateDiagram-v2 ## Sequence diagram -The following diagram shows the end-to-end flow for a verifier to request and verify a proof presentation from a Holder/prover. +The following diagram shows the end-to-end flow for a verifier to request and verify a proof presentation from a Holder/prover. ### JWT Present Proof Flow Diagram ![](present-proof-flow.png) diff --git a/docs/docusaurus/credentials/revocation.md b/docs/docusaurus/credentials/revocation.md index ce1ee9baa0..997a66f4ac 100644 --- a/docs/docusaurus/credentials/revocation.md +++ b/docs/docusaurus/credentials/revocation.md @@ -8,11 +8,11 @@ Every credential will contain the property `credentialStatus`, which will look l ```json "credentialStatus": { - "id": "http://localhost:8080/prism-agent/prism-agent/credential-status/27526236-3836-4061-9867-f69314e258b4#94567" + "id": "http://localhost:8080/cloud-agent/cloud-agent/credential-status/27526236-3836-4061-9867-f69314e258b4#94567" "type": "StatusList2021Entry", "statusPurpose": "revocation", "statusListIndex": "94567", - "statusListCredential": "http://localhost:8080/prism-agent/prism-agent/credential-status/27526236-3836-4061-9867-f69314e258b4" + "statusListCredential": "http://localhost:8080/cloud-agent/cloud-agent/credential-status/27526236-3836-4061-9867-f69314e258b4" }, ``` @@ -36,7 +36,7 @@ Every credential will contain the property `credentialStatus`, which will look l "VerifiableCredential", "StatusList2021Credential" ], - "id" : "http://localhost:8080/prism-agent/credential-status/27526236-3836-4061-9867-f69314e258b4", + "id" : "http://localhost:8080/cloud-agent/credential-status/27526236-3836-4061-9867-f69314e258b4", "issuer" : "did:prism:462c4811bf61d7de25b3baf86c5d2f0609b4debe53792d297bf612269bf8593a", "issuanceDate" : 1711212350, "credentialSubject" : { @@ -69,12 +69,12 @@ Status list credential integrity can be verified using the embedded proof of typ ## Revocation -Only issuers of a credential can revoke a credential. +Only issuers of a credential can revoke a credential. *Get the list of credentials* ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/issue-credentials/records' \ + 'http://localhost:8080/cloud-agent/issue-credentials/records' \ -H 'accept: application/json' ``` This endpoint will return the credentials issued. Every credential includes an ID. @@ -82,7 +82,7 @@ This endpoint will return the credentials issued. Every credential includes an I *Revoke the credential* ```bash curl -X 'PATCH' \ - 'http://localhost:8080/prism-agent/revoke-credential/' \ + 'http://localhost:8080/cloud-agent/revoke-credential/' \ -H 'accept: */*' ``` diff --git a/docs/docusaurus/dids/create.md b/docs/docusaurus/dids/create.md index b8e616d288..2496a3a13e 100644 --- a/docs/docusaurus/dids/create.md +++ b/docs/docusaurus/dids/create.md @@ -45,7 +45,7 @@ The example uses the following endpoints ### 1. Check existing DID on the Cloud Agent ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/did-registrar/dids' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/did-registrar/dids' \ --header "apikey: $API_KEY" \ --header 'Accept: application/json' ``` @@ -58,7 +58,7 @@ Since key pairs are generated and managed by the Cloud Agent, DID controller onl The current PRISM DID method supports a key with a single purpose, but it is extendible to support a key with multiple purposes in the future. ```bash -curl --location --request POST 'http://localhost:8080/prism-agent/did-registrar/dids' \ +curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/dids' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header "apikey: $API_KEY" \ @@ -97,8 +97,8 @@ Check the `GET /did-registrar/dids` endpoint. The response should return a list } ], "kind": "ManagedDIDPage", - "pageOf": "http://localhost:8080/prism-agent/did-registrar/dids", - "self": "http://localhost:8080/prism-agent/did-registrar/dids" + "pageOf": "http://localhost:8080/cloud-agent/did-registrar/dids", + "self": "http://localhost:8080/cloud-agent/did-registrar/dids" } ``` @@ -110,7 +110,7 @@ Replacing the `{didRef}` with the long-form DID, and the response should return Replacing the `{didRef}` with the short-form DID, and the resolution should fail since the DID still needs to be published. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/dids/{didRef}' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/dids/{didRef}' \ --header "apikey: $API_KEY" \ --header 'Accept: */*' ``` diff --git a/docs/docusaurus/dids/deactivate.md b/docs/docusaurus/dids/deactivate.md index 9fb1ac4918..e6527a62fc 100644 --- a/docs/docusaurus/dids/deactivate.md +++ b/docs/docusaurus/dids/deactivate.md @@ -45,7 +45,7 @@ The example uses the following endpoints Given the DID Controller has a DID managed by the Cloud Agent and that DID is published, he can resolve the DID document using short-form DID. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/dids/{didRef}' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/dids/{didRef}' \ --header "apikey: $API_KEY" \ --header 'Accept: */*' ``` @@ -71,7 +71,7 @@ The active status comes from the last step. The DID deactivation can be performed by calling `POST /did-registrar/dids/{didRef}/deactivations` and replacing `{didRef}` with the DID to deactivate. ```bash -curl --location --request POST 'http://localhost:8080/prism-agent/did-registrar/dids/{didRef}/deactivations' \ +curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/dids/{didRef}/deactivations' \ --header "apikey: $API_KEY" \ --header 'Accept: application/json' ``` diff --git a/docs/docusaurus/dids/publish.md b/docs/docusaurus/dids/publish.md index b233cbc19a..90da0dde4a 100644 --- a/docs/docusaurus/dids/publish.md +++ b/docs/docusaurus/dids/publish.md @@ -49,7 +49,7 @@ The `{didRef}` path segment can be either short-form or long-form DID. When a DID gets created and not published, it has the status of `CREATED`. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/did-registrar/dids/{didRef}' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/did-registrar/dids/{didRef}' \ --header "apikey: $API_KEY" \ --header 'Accept: application/json' ``` @@ -68,7 +68,7 @@ Example response To publish a DID, use DID Controller `POST` a request to `/did-registrar/dids/{didRef}/publications` endpoint. ```bash -curl --location --request POST 'http://localhost:8080/prism-agent/did-registrar/dids/{didRef}/publications' \ +curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/dids/{didRef}/publications' \ --header "apikey: $API_KEY" \ --header 'Accept: application/json' ``` @@ -127,7 +127,7 @@ To confirm that the short-form DID is resolvable, test the DID against the resol Replace `{didRef}` with the short-form DID; the response should return a DID document. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/dids/{didRef}' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/dids/{didRef}' \ --header "apikey: $API_KEY" \ --header 'Accept: */*' ``` diff --git a/docs/docusaurus/dids/update.md b/docs/docusaurus/dids/update.md index 22fb55c7fd..b3e5e6760f 100644 --- a/docs/docusaurus/dids/update.md +++ b/docs/docusaurus/dids/update.md @@ -62,7 +62,7 @@ The example uses the following endpoints Given the DID Controller has a DID on the Cloud Agent and that DID is published, he can resolve the DID document using short-form DID. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/dids/{didRef}' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/dids/{didRef}' \ --header "apikey: $API_KEY" \ --header 'Accept: */*' ``` @@ -104,7 +104,7 @@ The DID Controller wishes to remove that key and add a new key called `key-2` The DID Controller submits a DID update request to `POST /did-registrar/dids/{didRef}/updates`. ```bash -curl --location --request POST 'http://localhost:8080/prism-agent/did-registrar/dids/did:prism:4262377859267f308a06ec6acf211fbe4d6745aa9e637e04548771169616fb86/updates' \ +curl --location --request POST 'http://localhost:8080/cloud-agent/did-registrar/dids/did:prism:4262377859267f308a06ec6acf211fbe4d6745aa9e637e04548771169616fb86/updates' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header "apikey: $API_KEY" \ diff --git a/docs/docusaurus/index.md b/docs/docusaurus/index.md index 45301dd870..e483a47ee5 100644 --- a/docs/docusaurus/index.md +++ b/docs/docusaurus/index.md @@ -9,14 +9,14 @@ Whether you are new to [self-sovereign identity (SSI)](/docs/concepts/glossary#s Throughout all code examples in tutorials, the following conventions are in use: * Issuer Keycloak is hosted at `http://localhost:9980/` -* Issuer Agent is hosted at `http://localhost:8080/prism-agent/` -* Holder Agent is hosted at `http://localhost:8090/prism-agent/` -* Verifier Agent is hosted at `http://localhost:8100/prism-agent/` +* Issuer Agent is hosted at `http://localhost:8080/cloud-agent/` +* Holder Agent is hosted at `http://localhost:8090/cloud-agent/` +* Verifier Agent is hosted at `http://localhost:8100/cloud-agent/` :::info To use the Identus Cloud Agents, you must include an `apiKey` header in your requests. You can configure the key, and in some instances, it will be provided to you, so make sure to create an environment variable with the proper value. ```shell export API_KEY= ``` -Alternatively, replace `$API_KEY` with your key in the CURL commands supplied throughout this tutorial. ::: +Alternatively, replace `$API_KEY` with your key in the CURL commands supplied throughout this tutorial. ::: diff --git a/docs/docusaurus/multitenancy/admin-authz-ext-iam.md b/docs/docusaurus/multitenancy/admin-authz-ext-iam.md index 28ab7e4025..983b50f3c5 100644 --- a/docs/docusaurus/multitenancy/admin-authz-ext-iam.md +++ b/docs/docusaurus/multitenancy/admin-authz-ext-iam.md @@ -18,16 +18,16 @@ The same person may also represent these roles. 1. Keycloak is up and running 2. Keycloak is configured as follows 1. A realm called `my-realm` is created - 2. A client called `prism-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) - 3. Make sure the `prism-agent` client has __direct access grants__ enabled to simplify the login + 2. A client called `cloud-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) + 3. Make sure the `cloud-agent` client has __direct access grants__ enabled to simplify the login 3. The Cloud Agent is up and running 4. The Cloud Agent is configured with the following environment variables: 1. `KEYCLOAK_ENABLED=true` 2. `KEYCLOAK_URL=http://localhost:9980` (replace with appropriate value) 3. `KEYCLOAK_REALM=my-realm` - 4. `KEYCLOAK_CLIENT_ID=prism-agent` + 4. `KEYCLOAK_CLIENT_ID=cloud-agent` 5. `KEYCLOAK_CLIENT_SECRET=` (replace with appropriate value) - 6. `KEYCLOAL_ROLES_CLAIM_PATH=resource_access.prism-agent.roles` + 6. `KEYCLOAL_ROLES_CLAIM_PATH=resource_access.cloud-agent.roles` ## Overview @@ -42,14 +42,14 @@ Despite UMA permissions configured for the user, the agent strictly maintains a ## Endpoints ### Agent endpoints -| Endpoint | Description | Role | -|--------------------------------------------|-------------------------------------|---------------| -| `GET /wallets` | List the wallets on the Cloud Agent | Administrator | +| Endpoint | Description | Role | +|----------------|-------------------------------------|---------------| +| `GET /wallets` | List the wallets on the Cloud Agent | Administrator | ### Keycloak endpoints -| Endpoint | Description | Role | -|------------------------------------------------------|-------------------------------|--------------| -| `POST /realms/{realm}/protocol/openid-connect/token` | Issue a new JWT token | Administrator| +| Endpoint | Description | Role | +|------------------------------------------------------|-----------------------|---------------| +| `POST /realms/{realm}/protocol/openid-connect/token` | Issue a new JWT token | Administrator | ## Keycloak Administrator interactions @@ -109,7 +109,7 @@ Inspecting the `access_token` payload, it should have the following content ```json { "resource_access": { - "prism-agent": { + "cloud-agent": { "roles": [ "admin" ] @@ -132,7 +132,7 @@ To prove that the admin can perform admin tasks, try listing all the tenants' wallets using the JWT in the `Authorization` header. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/wallets' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/wallets' \ -H 'Authorization: Bearer eyJhbGciOi...e7H6W8RUvA' \ -H 'Accept: application/json' ``` diff --git a/docs/docusaurus/multitenancy/tenant-migration.md b/docs/docusaurus/multitenancy/tenant-migration.md index 2f0cfd94f0..7be06751dc 100644 --- a/docs/docusaurus/multitenancy/tenant-migration.md +++ b/docs/docusaurus/multitenancy/tenant-migration.md @@ -50,7 +50,7 @@ To find the wallet, list them using `apikey`. ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H "apikey: my-tenant-token" ``` @@ -126,7 +126,7 @@ To do this, invoke the `POST /wallets/{walletId}/uma-permissions` endpoint on th ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/wallets/99734c87-5c9d-4697-b5fd-dea4e9590ba7/uma-permissions' \ + 'http://localhost:8080/cloud-agent/wallets/99734c87-5c9d-4697-b5fd-dea4e9590ba7/uma-permissions' \ -v \ -H 'accept: */*' \ -H "apikey: my-tenant-token" \ @@ -147,7 +147,7 @@ List the wallet using a new `Authorization` header. The listed wallets should co ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H 'Authorization: Bearer eyJhbGciOi...7ocDHofUDQ' ``` diff --git a/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam.md b/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam.md index ce0c7d8e49..61aee50ac5 100644 --- a/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam.md +++ b/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam.md @@ -19,8 +19,8 @@ In tenant management with external IAM, there are 2 roles: 1. Keycloak up and running 2. Keycloak is configured as follows 1. A realm called `my-realm` is created - 2. A client called `prism-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) - 3. Make sure the `prism-agent` client has __direct access grants__ enabled to simplify the login process for this tutorial + 2. A client called `cloud-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) + 3. Make sure the `cloud-agent` client has __direct access grants__ enabled to simplify the login process for this tutorial 3. the Cloud Agent is up and running 4. the Cloud Agent is configured with the following environment variables: 1. `ADMIN_TOKEN=my-admin-token` @@ -28,7 +28,7 @@ In tenant management with external IAM, there are 2 roles: 3. `KEYCLOAK_ENABLED=true` 4. `KEYCLOAK_URL=http://localhost:9980` (replace with appropriate value) 5. `KEYCLOAK_REALM=my-realm` - 6. `KEYCLOAK_CLIENT_ID=prism-agent` + 6. `KEYCLOAK_CLIENT_ID=cloud-agent` 7. `KEYCLOAK_CLIENT_SECRET=` (replace with appropriate value) 8. `KEYCLOAK_UMA_AUTO_UPGRADE_RPT=false` @@ -75,7 +75,7 @@ Listing wallets on it should return empty results. ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H 'x-admin-api-key: my-admin-token' ``` @@ -100,7 +100,7 @@ Provide a wallet seed during the wallet creation or let the Agent generate one ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H 'x-admin-api-key: my-admin-token' \ -H 'Content-Type: application/json' \ @@ -196,7 +196,7 @@ This can be done by invoking the `POST /wallets/{walletId}/uma-permissions` endp ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/wallets/99734c87-5c9d-4697-b5fd-dea4e9590ba7/uma-permissions' \ + 'http://localhost:8080/cloud-agent/wallets/99734c87-5c9d-4697-b5fd-dea4e9590ba7/uma-permissions' \ -v \ -H 'accept: */*' \ -H 'x-admin-api-key: my-admin-token' \ @@ -258,7 +258,7 @@ curl -X POST \ 'http://localhost:9980/realms/my-realm/protocol/openid-connect/token' \ -H "Authorization: Bearer eyJhbGciOi...7ocDHofUDQ" \ -d "grant_type=urn:ietf:params:oauth:grant-type:uma-ticket" \ - -d "audience=prism-agent" + -d "audience=cloud-agent" ``` Example token response (some fields omitted for readability) @@ -297,7 +297,7 @@ To prove that the tenant can access the wallet using RPT, try listing the DIDs in the wallet using RPT in the `Authorization` header. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/did-registrar/dids' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/did-registrar/dids' \ -H 'Authorization: Bearer eyJhbGciOi...e7H6W8RUvA' \ -H 'Accept: application/json' ``` diff --git a/docs/docusaurus/multitenancy/tenant-onboarding-self-service.md b/docs/docusaurus/multitenancy/tenant-onboarding-self-service.md index d6b8fe91e7..3bdbef2e01 100644 --- a/docs/docusaurus/multitenancy/tenant-onboarding-self-service.md +++ b/docs/docusaurus/multitenancy/tenant-onboarding-self-service.md @@ -22,8 +22,8 @@ In self-service tenant management with external IAM, there is only one role: 1. Keycloak is up and running. 2. Keycloak is configured as follows 1. A realm called `my-realm` is created - 2. A client called `prism-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) - 3. Make sure the `prism-agent` client has __direct access grants__ enabled to simplify the login process for this tutorial. + 2. A client called `cloud-agent` under `my-realm` with __authorization__ feature is created. (See [create client instruction](https://www.keycloak.org/docs/latest/authorization_services/index.html#_resource_server_create_client)) + 3. Make sure the `cloud-agent` client has __direct access grants__ enabled to simplify the login process for this tutorial. 4. Make sure to [allow user self-registration](https://www.keycloak.org/docs/latest/server_admin/index.html#con-user-registration_server_administration_guide). 3. The Cloud Agent is up and running 4. The Cloud Agent is configured with the following environment variables: @@ -32,7 +32,7 @@ In self-service tenant management with external IAM, there is only one role: 3. `KEYCLOAK_ENABLED=true` 4. `KEYCLOAK_URL=http://localhost:9980` (replace with appropriate value) 5. `KEYCLOAK_REALM=my-realm` - 6. `KEYCLOAK_CLIENT_ID=prism-agent` + 6. `KEYCLOAK_CLIENT_ID=cloud-agent` 7. `KEYCLOAK_CLIENT_SECRET=` (replace with appropriate value) 8. `KEYCLOAK_UMA_AUTO_UPGRADE_RPT=true` @@ -102,7 +102,7 @@ Listing wallets on it should return empty results. ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'Authorization: Bearer eyJhbGciOi...7ocDHofUDQ' \ -H 'Accept: application/json' ``` @@ -130,7 +130,7 @@ If the user already has the wallet associated, the wallet creation will fail as ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'Authorization: Bearer eyJhbGciOi...7ocDHofUDQ' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ @@ -159,7 +159,7 @@ Without further operation, the wallet should be available for the tenant. To prove that the tenant can access the wallet, list the DIDs using RPT in the `Authorization` header. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/did-registrar/dids' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/did-registrar/dids' \ -H 'Authorization: Bearer eyJhbGciOi...7ocDHofUDQ' \ -H 'Accept: application/json' ``` diff --git a/docs/docusaurus/multitenancy/tenant-onboarding.md b/docs/docusaurus/multitenancy/tenant-onboarding.md index 55fc98c41a..815b162b50 100644 --- a/docs/docusaurus/multitenancy/tenant-onboarding.md +++ b/docs/docusaurus/multitenancy/tenant-onboarding.md @@ -48,7 +48,7 @@ Listing wallets on it should return empty results. ```bash curl -X 'GET' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H 'x-admin-api-key: my-admin-token' ``` @@ -72,7 +72,7 @@ The wallet seed may be provided during the wallet creation or omitted to let the ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/wallets' \ + 'http://localhost:8080/cloud-agent/wallets' \ -H 'accept: application/json' \ -H 'x-admin-api-key: my-admin-token' \ -H 'Content-Type: application/json' \ @@ -100,7 +100,7 @@ To create a new entity, send a `POST` request to the `/iam/entities` endpoint wi ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/iam/entities' \ + 'http://localhost:8080/cloud-agent/iam/entities' \ -H 'accept: application/json' \ -H 'x-admin-api-key: my-admin-token' \ -H 'Content-Type: application/json' \ @@ -134,7 +134,7 @@ Once this step is completed, the administrator should provide the tenant with an ```bash curl -X 'POST' \ - 'http://localhost:8080/prism-agent/iam/apikey-authentication' \ + 'http://localhost:8080/cloud-agent/iam/apikey-authentication' \ -H 'accept: */*' \ -H 'x-admin-api-key: my-admin-token' \ -H 'Content-Type: application/json' \ @@ -158,7 +158,7 @@ To prove that the tenant can be authenticated as the created entity and use the try listing the DIDs in the wallet using `apikey` header. ```bash -curl --location --request GET 'http://localhost:8080/prism-agent/did-registrar/dids' \ +curl --location --request GET 'http://localhost:8080/cloud-agent/did-registrar/dids' \ --header "apikey: my-tenant-token" \ --header 'Accept: application/json' ``` diff --git a/docs/docusaurus/schemas/create.md b/docs/docusaurus/schemas/create.md index ef5e0d7ca1..edfd7454f3 100644 --- a/docs/docusaurus/schemas/create.md +++ b/docs/docusaurus/schemas/create.md @@ -67,7 +67,7 @@ For the above fields, the JSON Schema definition must be: The fields `$id` and `$schema` must correspond values that describe - the identity of the given JSON Schema as a **correctly formatted URL** `https://example.com/driving-license-1.0.0` and -- the meta schema fixed to `https://json-schema.org/draft/2020-12/schema` which is the only supported value +- the meta schema fixed to `https://json-schema.org/draft/2020-12/schema` which is the only supported value All the claims are listed under the `properties` object with corresponding `type`s and `format`s according to JSON Specification. @@ -79,7 +79,7 @@ Specification. 1. Open your preferred REST API client, such as Postman or Insomnia, or use the client stub generated based on the OpenAPI specification. -2. In the client, create a new POST request to the `/prism-agent/schema-registry/schemas` endpoint. +2. In the client, create a new POST request to the `/cloud-agent/schema-registry/schemas` endpoint. Note that the value of the `author` field must match the short form of a PRISM DID that has been created using the same agent. An unpublished DID is sufficient. Please refer to the [Create DID](../dids/create.md) documentation page for more details on how to create a PRISM DID. @@ -141,7 +141,7 @@ In the request body, create a JSON object: ```shell curl -X 'POST' \ - 'http://localhost:8080/prism-agent/schema-registry/schemas' \ + 'http://localhost:8080/cloud-agent/schema-registry/schemas' \ -H 'accept: application/json' \ -H "apikey: $API_KEY" \ -H 'Content-Type: application/json' \ @@ -254,13 +254,13 @@ curl -X 'POST' \ ### 3. Retrieve the created schema -To retrieve the newly created schema, create a new GET request to the `/prism-agent/schema-registry/schemas/{guid}` +To retrieve the newly created schema, create a new GET request to the `/cloud-agent/schema-registry/schemas/{guid}` endpoint, where `{guid}` is the GUID returned in the response from the previous step. Send the GET request to retrieve the schema. Curl example is the following: ```shell curl -X 'GET' \ - 'http://localhost:8080/prism-agent/schema-registry/schemas/3f86a73f-5b78-39c7-af77-0c16123fa9c2' \ + 'http://localhost:8080/cloud-agent/schema-registry/schemas/3f86a73f-5b78-39c7-af77-0c16123fa9c2' \ -H 'accept: application/json' \ -H "apikey: $API_KEY" ``` diff --git a/docs/docusaurus/schemas/update.md b/docs/docusaurus/schemas/update.md index abd60ed9b7..17010d13cc 100644 --- a/docs/docusaurus/schemas/update.md +++ b/docs/docusaurus/schemas/update.md @@ -108,13 +108,13 @@ The JSON Schema changes must be defined as follows: 1. Open your preferred REST API client, such as Postman or Insomnia, or use the client stub generated based on the OpenAPI specification. -2. In the client, create a new PUT request to the `/prism-agent/schema-registry/schemas/{id}` endpoint, where `id` is a +2. In the client, create a new PUT request to the `/cloud-agent/schema-registry/schemas/{id}` endpoint, where `id` is a locally unique credential schema id, formatted as a URL. -Note that the value of the `author` field must match the short form of a PRISM DID that has been created using the same agent. An unpublished DID is sufficient. Please refer to the [Create DID](../dids/create.md) documentation page for more details on how to create a PRISM DID. +Note that the value of the `author` field must match the short form of a PRISM DID that has been created using the same agent. An unpublished DID is sufficient. Please refer to the [Create DID](../dids/create.md) documentation page for more details on how to create a PRISM DID. In the request body, create a JSON object: - + ```json { "name": "driving-license", @@ -184,7 +184,7 @@ The curl example might be the following: ```shell curl -X 'PUT' \ - 'http://localhost:8080/prism-agent/schema-registry/schemas/f2bfbf78-8bd6-4cc6-8b39-b3a25e01e8ea' \ + 'http://localhost:8080/cloud-agent/schema-registry/schemas/f2bfbf78-8bd6-4cc6-8b39-b3a25e01e8ea' \ -H 'accept: application/json' \ -H "apikey: $API_KEY" \ -H 'Content-Type: application/json' \ diff --git a/docs/docusaurus/webhooks/webhook.md b/docs/docusaurus/webhooks/webhook.md index 25069f484d..511caf06d1 100644 --- a/docs/docusaurus/webhooks/webhook.md +++ b/docs/docusaurus/webhooks/webhook.md @@ -64,7 +64,7 @@ For each individual wallet, users can create a new webhook by making a POST requ which in turn creates a new webhook resource specific to their wallet. ```bash -curl --location --request POST 'http://localhost:8080/prism-agent/events/webhooks' \ +curl --location --request POST 'http://localhost:8080/cloud-agent/events/webhooks' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header "apiKey: $API_KEY" \ diff --git a/docs/guides/linting.md b/docs/guides/linting.md index dc26ac5f23..812ae396c3 100644 --- a/docs/guides/linting.md +++ b/docs/guides/linting.md @@ -128,7 +128,7 @@ Linter - Suggested Change: Customise In /github/workspace/infrastructure/dev/get-versions.sh line 8: - export AGENT_VERSION=$(cd ../../prism-agent/service && sbt "project server" -Dsbt.supershell=false -error "print version") + export AGENT_VERSION=$(cd ../../cloud-agent/service && sbt "project server" -Dsbt.supershell=false -error "print version") ^-----------------^ SC2155 (warning): Declare and assign separately to avoid masking return values. For more information: diff --git a/infrastructure/charts/agent/templates/apisixroute.yaml b/infrastructure/charts/agent/templates/apisixroute.yaml index 47f1f5a0b9..b45ad9a7ea 100644 --- a/infrastructure/charts/agent/templates/apisixroute.yaml +++ b/infrastructure/charts/agent/templates/apisixroute.yaml @@ -16,6 +16,7 @@ spec: {{- end }} paths: - /prism-agent/* + - /cloud-agent/* backends: - serviceName: agent-server-tapir-service servicePort: 8085 @@ -26,7 +27,7 @@ spec: - name: proxy-rewrite enable: true config: - regex_uri: ["^/prism-agent/(.*)","/$1"] + regex_uri: ["^/(prism-agent|cloud-agent)/(.*)","/$2"] - name: uri-blocker enable: true config: @@ -56,6 +57,7 @@ spec: {{- end }} paths: - /prism-agent/didcomm* + - /cloud-agent/didcomm* backends: - serviceName: agent-server-didcomm-service servicePort: 8090 @@ -63,7 +65,7 @@ spec: - name: proxy-rewrite enable: true config: - regex_uri: ["^/prism-agent/didcomm(.*)", "/$1"] + regex_uri: ["^/(prism-agent|cloud-agent)/didcomm(.*)", "/$2"] {{ template "cors" . }} {{ template "headers.requestId" . }} {{ template "headers.security" . }} @@ -87,6 +89,7 @@ spec: {{- end }} paths: - /prism-agent/schema-registry/schemas/* + - /cloud-agent/schema-registry/schemas/* methods: - GET backends: @@ -96,7 +99,7 @@ spec: - name: proxy-rewrite enable: true config: - regex_uri: ["^/prism-agent/schema-registry/schemas/(.*)", "/schema-registry/schemas/$1"] + regex_uri: ["^/(prism-agent|cloud-agent)/schema-registry/schemas/(.*)", "/schema-registry/schemas/$2"] {{ template "cors" . }} {{ template "headers.requestId" . }} {{ template "headers.security" . }} @@ -120,6 +123,7 @@ spec: {{- end }} paths: - /prism-agent/credential-definition-registry/definitions/* + - /cloud-agent/credential-definition-registry/definitions/* methods: - GET backends: @@ -129,7 +133,7 @@ spec: - name: proxy-rewrite enable: true config: - regex_uri: ["^/prism-agent/credential-definition-registry/definitions/(.*)", "/credential-definition-registry/definitions/$1"] + regex_uri: ["^/(prism-agent|cloud-agent)/credential-definition-registry/definitions/(.*)", "/credential-definition-registry/definitions/$2"] {{ template "cors" . }} {{ template "headers.requestId" . }} {{ template "headers.security" . }} @@ -153,6 +157,7 @@ spec: {{- end }} paths: - /prism-agent/docs/* + - /cloud-agent/docs/* backends: - serviceName: agent-server-tapir-service servicePort: 8085 @@ -160,7 +165,7 @@ spec: - name: proxy-rewrite enable: true config: - regex_uri: ["^/prism-agent/docs/(.*)","/docs/$1"] + regex_uri: ["^/(prism-agent|cloud-agent)/docs/(.*)","/docs/$2"] {{ template "cors" . }} {{ template "headers.requestId" . }} {{ template "headers.security" . }} diff --git a/infrastructure/charts/agent/templates/deployment.yaml b/infrastructure/charts/agent/templates/deployment.yaml index 22f85c74bc..4621487079 100644 --- a/infrastructure/charts/agent/templates/deployment.yaml +++ b/infrastructure/charts/agent/templates/deployment.yaml @@ -168,9 +168,9 @@ spec: key: password optional: false - name: DIDCOMM_SERVICE_URL - value: "https://{{ index .Values.ingress.applicationUrls 0 }}/prism-agent/didcomm" + value: "https://{{ index .Values.ingress.applicationUrls 0 }}/cloud-agent/didcomm" - name: REST_SERVICE_URL - value: "https://{{ index .Values.ingress.applicationUrls 0 }}/prism-agent" + value: "https://{{ index .Values.ingress.applicationUrls 0 }}/cloud-agent" - name: PRISM_NODE_HOST value: {{ .Values.vdrManager.host | quote }} - name: PRISM_NODE_PORT diff --git a/infrastructure/ci/docker-compose-multiple-actors.yml b/infrastructure/ci/docker-compose-multiple-actors.yml deleted file mode 100644 index a13c64e2d1..0000000000 --- a/infrastructure/ci/docker-compose-multiple-actors.yml +++ /dev/null @@ -1,154 +0,0 @@ -version: "3.8" - -services: - ########################## - # Pollux Databases - ########################## - - db_pollux_issuer: - image: postgres:13 - restart: always - environment: - POSTGRES_DB: pollux_issuer - POSTGRES_USER: postgres - POSTGRES_PASSWORD: postgres - ports: - - 5435:5432 - volumes: - - pg_data_pollux_db_issuer:/var/lib/postgresql/data - healthcheck: - test: ["CMD", "pg_isready", "-U", "postgres", "-d", "pollux_issuer"] - interval: 10s - timeout: 5s - retries: 5 - - db_pollux_holder: - image: postgres:13 - restart: always - environment: - POSTGRES_DB: pollux_holder - POSTGRES_USER: postgres - POSTGRES_PASSWORD: postgres - ports: - - 5436:5432 - volumes: - - pg_data_pollux_db_holder:/var/lib/postgresql/data - healthcheck: - test: ["CMD", "pg_isready", "-U", "postgres", "-d", "pollux_holder"] - interval: 10s - timeout: 5s - retries: 5 - - ########################## - # Connect Databases - ########################## - - db_connect_issuer: - image: postgres:13 - restart: always - environment: - POSTGRES_DB: connect_issuer - POSTGRES_USER: postgres - POSTGRES_PASSWORD: postgres - ports: - - 5437:5432 - volumes: - - pg_data_connect_db_issuer:/var/lib/postgresql/data - healthcheck: - test: ["CMD", "pg_isready", "-U", "postgres", "-d", "connect_issuer"] - interval: 10s - timeout: 5s - retries: 5 - - db_connect_holder: - image: postgres:13 - restart: always - environment: - POSTGRES_DB: connect_holder - POSTGRES_USER: postgres - POSTGRES_PASSWORD: postgres - ports: - - 5438:5432 - volumes: - - pg_data_connect_db_holder:/var/lib/postgresql/data - healthcheck: - test: ["CMD", "pg_isready", "-U", "postgres", "-d", "connect_holder"] - interval: 10s - timeout: 5s - retries: 5 - - ########################## - # Services - ##########################c - - prism-agent-issuer: - image: ghcr.io/hyperledger/prism-agent:0.5.0 - environment: - REST_SERVICE_PORT: 8080 - DIDCOMM_SERVICE_PORT: 8081 - CASTOR_DB_HOST: db_castor_issuer - CASTOR_DB_PORT: 5432 - CASTOR_DB_NAME: castor_issuer - CASTOR_DB_USER: postgres - CASTOR_DB_PASSWORD: postgres - POLLUX_DB_HOST: db_pollux_issuer - POLLUX_DB_PORT: 5432 - POLLUX_DB_NAME: pollux_issuer - POLLUX_DB_USER: postgres - POLLUX_DB_PASSWORD: postgres - CONNECT_DB_HOST: db_connect_issuer - CONNECT_DB_PORT: 5432 - CONNECT_DB_NAME: connect_issuer - CONNECT_DB_USER: postgres - CONNECT_DB_PASSWORD: postgres - DIDCOMM_SERVICE_URL: "http://prism-agent-issuer" - ports: - - "8080:8080" - - "8081:8081" - depends_on: - - db_castor_issuer - - db_pollux_issuer - healthcheck: - test: ["CMD", "curl", "-f", "http://prism-agent-issuer:8080/dids/xyz"] - interval: 30s - timeout: 10s - retries: 5 - - prism-agent-holder: - image: ghcr.io/hyperledger/prism-agent:0.5.0 - environment: - REST_SERVICE_PORT: 8090 - DIDCOMM_SERVICE_PORT: 8091 - CASTOR_DB_HOST: db_castor_holder - CASTOR_DB_PORT: 5432 - CASTOR_DB_NAME: castor_holder - CASTOR_DB_USER: postgres - CASTOR_DB_PASSWORD: postgres - POLLUX_DB_HOST: db_pollux_holder - POLLUX_DB_PORT: 5432 - POLLUX_DB_NAME: pollux_holder - POLLUX_DB_USER: postgres - POLLUX_DB_PASSWORD: postgres - CONNECT_DB_HOST: db_connect_holder - CONNECT_DB_PORT: 5432 - CONNECT_DB_NAME: connect_holder - CONNECT_DB_USER: postgres - CONNECT_DB_PASSWORD: postgres - DIDCOMM_SERVICE_URL: "http://prism-agent-holder" - ports: - - "8090:8090" - - "8091:8091" - depends_on: - - db_castor_holder - - db_pollux_holder - healthcheck: - test: ["CMD", "curl", "-f", "http://prism-agent-holder:8090/dids/xyz"] - interval: 30s - timeout: 10s - retries: 5 - -volumes: - pg_data_pollux_db_issuer: - pg_data_pollux_db_holder: - pg_data_connect_db_issuer: - pg_data_connect_db_holder: diff --git a/infrastructure/local/.env b/infrastructure/local/.env index d18d8cae87..0f9249eb0c 100644 --- a/infrastructure/local/.env +++ b/infrastructure/local/.env @@ -1,3 +1,3 @@ -AGENT_VERSION=1.32.1 +AGENT_VERSION=1.32.1-SNAPSHOT PRISM_NODE_VERSION=2.2.1 VAULT_DEV_ROOT_TOKEN_ID=root diff --git a/infrastructure/local/run-e2e-tests-local.sh b/infrastructure/local/run-e2e-tests-local.sh index c8d6d2992f..d7a44a5d27 100755 --- a/infrastructure/local/run-e2e-tests-local.sh +++ b/infrastructure/local/run-e2e-tests-local.sh @@ -8,21 +8,21 @@ echo "--------------------------------------" echo "Starting multitenant using local/run.sh" echo "--------------------------------------" -${SCRIPT_DIR}/run.sh -p 8080 -n multitenant -w +"${SCRIPT_DIR}"/run.sh -p 8080 -n multitenant -w export AGENT_AUTH_REQUIRED=true export AGENT_AUTH_HEADER=apikey export ACME_AUTH_KEY=acme -export ACME_AGENT_URL=http://localhost:8080/prism-agent +export ACME_AGENT_URL=http://localhost:8080/cloud-agent export BOB_AUTH_KEY=bob -export BOB_AGENT_URL=http://localhost:8080/prism-agent +export BOB_AGENT_URL=http://localhost:8080/cloud-agent export FABER_AUTH_KEY=faber -export FABER_AGENT_URL=http://localhost:8080/prism-agent +export FABER_AGENT_URL=http://localhost:8080/cloud-agent -curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ +curl --location 'http://localhost:8080/cloud-agent/events/webhooks' \ --header "apikey: $ACME_AUTH_KEY" \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ @@ -30,7 +30,7 @@ curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ "url": "http://host.docker.internal:9955" }' -curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ +curl --location 'http://localhost:8080/cloud-agent/events/webhooks' \ --header "apikey: $BOB_AUTH_KEY" \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ @@ -38,7 +38,7 @@ curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ "url": "http://host.docker.internal:9956" }' -curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ +curl --location 'http://localhost:8080/cloud-agent/events/webhooks' \ --header "apikey: $FABER_AUTH_KEY" \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ @@ -47,6 +47,6 @@ curl --location 'http://localhost:8080/prism-agent/events/webhooks' \ }' ( - cd ${SCRIPT_DIR}/../../tests/e2e-tests/ + cd "${SCRIPT_DIR}"/../../tests/integration-tests/ ./gradlew test reports ) diff --git a/infrastructure/multi/run-e2e-tests-local.sh b/infrastructure/multi/run-e2e-tests-local.sh index 3ea71b45a5..6a6ed7f1f6 100755 --- a/infrastructure/multi/run-e2e-tests-local.sh +++ b/infrastructure/multi/run-e2e-tests-local.sh @@ -8,25 +8,25 @@ echo "--------------------------------------" echo "Starting issuer using local/run.sh" echo "--------------------------------------" -${SCRIPT_DIR}/../local/run.sh -p 8080 -n issuer -w +"${SCRIPT_DIR}"/../local/run.sh -p 8080 -n issuer -w echo "--------------------------------------" echo "Starting holder using local/run.sh" echo "--------------------------------------" -${SCRIPT_DIR}/../local/run.sh -p 8090 -n holder -w +"${SCRIPT_DIR}"/../local/run.sh -p 8090 -n holder -w echo "--------------------------------------" echo "Starting verifier using local/run.sh" echo "--------------------------------------" -${SCRIPT_DIR}/../local/run.sh -p 8100 -n verifier -w +"${SCRIPT_DIR}"/../local/run.sh -p 8100 -n verifier -w echo "--------------------------------------" echo "Run e2e tests" echo "--------------------------------------" ( - cd ${SCRIPT_DIR}/../../tests/e2e-tests/ + cd "${SCRIPT_DIR}"/../../tests/integration-tests/ ./gradlew test reports ) diff --git a/infrastructure/multi/run-e2e-tests-remote.sh b/infrastructure/multi/run-e2e-tests-remote.sh index 730de0ed8b..cb334fbf47 100755 --- a/infrastructure/multi/run-e2e-tests-remote.sh +++ b/infrastructure/multi/run-e2e-tests-remote.sh @@ -2,14 +2,17 @@ set -e -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) +SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd) echo "--------------------------------------" echo "Run e2e tests" echo "--------------------------------------" -export ACME_AGENT_URL=https://agent-df56h.atalaprism.io/prism-agent -export BOB_AGENT_URL=https://agent-kj46b.atalaprism.io/prism-agent -export MALLORY_AGENT_URL=https://agent-sd98k.atalaprism.io/prism-agent +export ACME_AGENT_URL=https://agent-df56h.atalaprism.io/cloud-agent +export BOB_AGENT_URL=https://agent-kj46b.atalaprism.io/cloud-agent +export MALLORY_AGENT_URL=https://agent-sd98k.atalaprism.io/cloud-agent -(cd ${SCRIPT_DIR}/../../tests/e2e-tests/; AGENT_AUTH_REQUIRED=true ./gradlew test reports) +( + cd "${SCRIPT_DIR}"/../../tests/e2e-tests/ + AGENT_AUTH_REQUIRED=true ./gradlew test reports +) diff --git a/infrastructure/shared/apisix/conf/apisix.yaml b/infrastructure/shared/apisix/conf/apisix.yaml index b26494025b..e0c68e958f 100644 --- a/infrastructure/shared/apisix/conf/apisix.yaml +++ b/infrastructure/shared/apisix/conf/apisix.yaml @@ -3,18 +3,18 @@ plugins: - name: cors routes: - - uri: /prism-agent/* + - uri: /cloud-agent/* upstream_id: 4 plugins: cors: allow_origins: "*" proxy-rewrite: - regex_uri: ["^/prism-agent/(.*)", "/$1"] - - uri: /docs/prism-agent/api/* + regex_uri: ["^/cloud-agent/(.*)", "/$1"] + - uri: /docs/cloud-agent/api/* upstream_id: 4 plugins: proxy-rewrite: - regex_uri: ["^/docs/prism-agent/api/(.*)", "/docs/$1"] + regex_uri: ["^/docs/cloud-agent/api/(.*)", "/docs/$1"] - uri: /didcomm* upstream_id: 3 plugins: @@ -31,11 +31,11 @@ routes: upstreams: - id: 3 nodes: - "prism-agent:8090": 1 # didcom and system + "cloud-agent:8090": 1 # didcom and system type: roundrobin - id: 4 nodes: - "prism-agent:8085": 1 # tapir + "cloud-agent:8085": 1 # tapir type: roundrobin - id: 5 nodes: diff --git a/infrastructure/shared/docker-compose-demo.yml b/infrastructure/shared/docker-compose-demo.yml index eecb80ac05..59eec1b988 100644 --- a/infrastructure/shared/docker-compose-demo.yml +++ b/infrastructure/shared/docker-compose-demo.yml @@ -28,11 +28,11 @@ services: db: condition: service_healthy - prism-agent: + cloud-agent: image: ghcr.io/hyperledger/identus-cloud-agent:${AGENT_VERSION} environment: DIDCOMM_SERVICE_URL: http://${DOCKERHOST}:${PORT}/didcomm - REST_SERVICE_URL: http://${DOCKERHOST}:${PORT}/prism-agent + REST_SERVICE_URL: http://${DOCKERHOST}:${PORT}/cloud-agent PRISM_NODE_HOST: prism-node PRISM_NODE_PORT: 50053 SECRET_STORAGE_BACKEND: postgres @@ -54,7 +54,7 @@ services: prism-node: condition: service_started healthcheck: - test: ["CMD", "curl", "-f", "http://prism-agent:8085/_system/health"] + test: ["CMD", "curl", "-f", "http://cloud-agent:8085/_system/health"] interval: 30s timeout: 10s retries: 5 @@ -65,7 +65,7 @@ services: image: swaggerapi/swagger-ui:v5.4.2 environment: - 'URLS=[ - { name: "Prism Agent", url: "/docs/prism-agent/api/docs.yaml" } + { name: "Cloud Agent", url: "/docs/cloud-agent/api/docs.yaml" } ]' apisix: @@ -76,7 +76,7 @@ services: ports: - "${PORT}:9080/tcp" depends_on: - - prism-agent + - cloud-agent - swagger-ui volumes: diff --git a/infrastructure/shared/docker-compose-mt-keycloak.yml b/infrastructure/shared/docker-compose-mt-keycloak.yml index ea7f76d8b5..30a0bf9829 100644 --- a/infrastructure/shared/docker-compose-mt-keycloak.yml +++ b/infrastructure/shared/docker-compose-mt-keycloak.yml @@ -69,7 +69,7 @@ services: timeout: 5s retries: 5 - prism-agent: + cloud-agent: image: ghcr.io/hyperledger/identus-cloud-agent:${AGENT_VERSION} environment: POLLUX_DB_HOST: db @@ -110,7 +110,7 @@ services: KEYCLOAK_ENABLED: true KEYCLOAK_URL: http://keycloak:8080 KEYCLOAK_REALM: atala-demo - KEYCLOAK_CLIENT_ID: prism-agent + KEYCLOAK_CLIENT_ID: prism-agent # TODO: Fix this later KEYCLOAK_CLIENT_SECRET: prism-agent-demo-secret KEYCLOAK_UMA_AUTO_UPGRADE_RPT: true depends_on: @@ -121,7 +121,7 @@ services: vault-server: condition: service_healthy healthcheck: - test: ["CMD", "curl", "-f", "http://prism-agent:8085/_system/health"] + test: ["CMD", "curl", "-f", "http://cloud-agent:8085/_system/health"] interval: 30s timeout: 10s retries: 5 @@ -132,7 +132,7 @@ services: image: swaggerapi/swagger-ui:v5.1.0 environment: - 'URLS=[ - { name: "Prism Agent", url: "/docs/prism-agent/api/docs.yaml" } + { name: "Cloud Agent", url: "/docs/cloud-agent/api/docs.yaml" } ]' apisix: @@ -143,7 +143,7 @@ services: ports: - "${PORT}:9080/tcp" depends_on: - - prism-agent + - cloud-agent - swagger-ui keycloak: diff --git a/infrastructure/shared/docker-compose.yml b/infrastructure/shared/docker-compose.yml index 7dbe179c6e..836dbd4c84 100644 --- a/infrastructure/shared/docker-compose.yml +++ b/infrastructure/shared/docker-compose.yml @@ -70,7 +70,7 @@ services: timeout: 5s retries: 5 - prism-agent: + cloud-agent: image: ghcr.io/hyperledger/identus-cloud-agent:${AGENT_VERSION} environment: POLLUX_DB_HOST: db @@ -88,9 +88,9 @@ services: AGENT_DB_NAME: agent AGENT_DB_USER: postgres AGENT_DB_PASSWORD: postgres - POLLUX_STATUS_LIST_REGISTRY_PUBLIC_URL: http://${DOCKERHOST}:${PORT}/prism-agent + POLLUX_STATUS_LIST_REGISTRY_PUBLIC_URL: http://${DOCKERHOST}:${PORT}/cloud-agent DIDCOMM_SERVICE_URL: http://${DOCKERHOST}:${PORT}/didcomm - REST_SERVICE_URL: http://${DOCKERHOST}:${PORT}/prism-agent + REST_SERVICE_URL: http://${DOCKERHOST}:${PORT}/cloud-agent PRISM_NODE_HOST: prism-node PRISM_NODE_PORT: 50053 VAULT_ADDR: ${VAULT_ADDR:-http://vault-server:8200} @@ -118,7 +118,7 @@ services: vault-server: condition: service_healthy healthcheck: - test: ["CMD", "curl", "-f", "http://prism-agent:8085/_system/health"] + test: ["CMD", "curl", "-f", "http://cloud-agent:8085/_system/health"] interval: 30s timeout: 10s retries: 5 @@ -129,7 +129,7 @@ services: image: swaggerapi/swagger-ui:v5.1.0 environment: - 'URLS=[ - { name: "Prism Agent", url: "/docs/prism-agent/api/docs.yaml" } + { name: "Cloud Agent", url: "/docs/cloud-agent/api/docs.yaml" } ]' apisix: @@ -140,7 +140,7 @@ services: ports: - "${PORT}:9080/tcp" depends_on: - - prism-agent + - cloud-agent - swagger-ui volumes: diff --git a/infrastructure/single-tenant-testing-stack/apisix/conf/apisix.yaml b/infrastructure/single-tenant-testing-stack/apisix/conf/apisix.yaml index 92a710f380..4e9fc1648f 100644 --- a/infrastructure/single-tenant-testing-stack/apisix/conf/apisix.yaml +++ b/infrastructure/single-tenant-testing-stack/apisix/conf/apisix.yaml @@ -7,31 +7,49 @@ routes: plugins: proxy-rewrite: regex_uri: ["^/issuer/prism-agent/(.*)", "/$1"] + - uri: /issuer/cloud-agent/* + upstream_id: 1 + plugins: + proxy-rewrite: + regex_uri: ["^/issuer/cloud-agent/(.*)", "/$1"] - uri: /issuer/didcomm* upstream_id: 2 plugins: proxy-rewrite: regex_uri: ["^/issuer/didcomm(.*)", "/$1"] + - uri: /verifier/prism-agent/* upstream_id: 3 plugins: proxy-rewrite: regex_uri: ["^/verifier/prism-agent/(.*)", "/$1"] + - uri: /verifier/cloud-agent/* + upstream_id: 3 + plugins: + proxy-rewrite: + regex_uri: ["^/verifier/cloud-agent/(.*)", "/$1"] - uri: /verifier/didcomm* upstream_id: 4 plugins: proxy-rewrite: regex_uri: ["^/verifier/didcomm(.*)", "/$1"] + - uri: /holder/prism-agent/* upstream_id: 5 plugins: proxy-rewrite: regex_uri: ["^/holder/prism-agent/(.*)", "/$1"] + - uri: /holder/cloud-agent/* + upstream_id: 5 + plugins: + proxy-rewrite: + regex_uri: ["^/holder/cloud-agent/(.*)", "/$1"] - uri: /holder/didcomm* upstream_id: 6 plugins: proxy-rewrite: regex_uri: ["^/holder/didcomm(.*)", "/$1"] + upstreams: - id: 1 nodes: diff --git a/infrastructure/single-tenant-testing-stack/run-e2e-tests-local.sh b/infrastructure/single-tenant-testing-stack/run-e2e-tests-local.sh index 98dcd604ee..d9b9747b5c 100755 --- a/infrastructure/single-tenant-testing-stack/run-e2e-tests-local.sh +++ b/infrastructure/single-tenant-testing-stack/run-e2e-tests-local.sh @@ -13,20 +13,20 @@ echo "--------------------------------------" echo "Starting stack using docker compose" echo "--------------------------------------" -PORT=${PORT} docker compose -f ${SCRIPT_DIR}/docker-compose.yml \ - --env-file ${ENV_FILE} up -d --wait +PORT=${PORT} docker compose -f "${SCRIPT_DIR}"/docker-compose.yml \ + --env-file "${ENV_FILE}" up -d --wait export AGENT_AUTH_REQUIRED=true -export ACME_AGENT_URL=http://localhost:${PORT}/issuer/prism-agent +export ACME_AGENT_URL=http://localhost:${PORT}/issuer/cloud-agent export ACME_AUTH_KEY=default -export BOB_AGENT_URL=http://localhost:${PORT}/verifier/prism-agent +export BOB_AGENT_URL=http://localhost:${PORT}/verifier/cloud-agent export BOB_AUTH_KEY=default -export MALLORY_AGENT_URL=http://localhost:${PORT}/holder/prism-agent +export MALLORY_AGENT_URL=http://localhost:${PORT}/holder/cloud-agent export MALLORY_AUTH_KEY=default -export FABER_AGENT_URL=http://localhost:${PORT}/holder/prism-agent +export FABER_AGENT_URL=http://localhost:${PORT}/holder/cloud-agent export FABER_AUTH_KEY=default ( - cd ${SCRIPT_DIR}/../../tests/e2e-tests/ + cd "${SCRIPT_DIR}"/../../tests/e2e-tests/ ./gradlew test reports ) diff --git a/infrastructure/single-tenant-testing-stack/run-performance-tests-local.sh b/infrastructure/single-tenant-testing-stack/run-performance-tests-local.sh index f45e698acf..167983367b 100755 --- a/infrastructure/single-tenant-testing-stack/run-performance-tests-local.sh +++ b/infrastructure/single-tenant-testing-stack/run-performance-tests-local.sh @@ -13,14 +13,14 @@ echo "--------------------------------------" echo "Starting stack using docker compose" echo "--------------------------------------" -PORT=${PORT} docker compose -f ${SCRIPT_DIR}/docker-compose.yml \ - --env-file ${ENV_FILE} up -d --wait +PORT=${PORT} docker compose -f "${SCRIPT_DIR}"/docker-compose.yml \ + --env-file "${ENV_FILE}" up -d --wait -export ISSUER_AGENT_URL=http://localhost:${PORT}/issuer/prism-agent +export ISSUER_AGENT_URL=http://localhost:${PORT}/issuer/cloud-agent export ISSUER_AGENT_API_KEY=default -export HOLDER_AGENT_URL=http://localhost:${PORT}/holder/prism-agent +export HOLDER_AGENT_URL=http://localhost:${PORT}/holder/cloud-agent export HOLDER_AGENT_API_KEY=default -export VERIFIER_AGENT_URL=http://localhost:${PORT}/verifier/prism-agent +export VERIFIER_AGENT_URL=http://localhost:${PORT}/verifier/cloud-agent export VERIFIER_AGENT_API_KEY=default echo "--------------------------------------" @@ -28,17 +28,17 @@ echo "Run perf tests" echo "--------------------------------------" ( - export K6_PROMETHEUS_RW_SERVER_URL=http://localhost:9090/api/v1/write - export K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM=true - cd ${SCRIPT_DIR}/../../tests/performance-tests/agent-performance-tests-k6 - yarn install - yarn webpack - k6 run -e SCENARIO_LABEL=st-create-prism-did-smoke dist/create-prism-did-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-credential-offer-smoke dist/credential-offer-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-credential-definition-smoke dist/credential-definition-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-credential-schema-smoke dist/credential-schema-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-did-publishing-smoke dist/did-publishing-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-connection-flow-smoke dist/connection-flow-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-issuance-flow-smoke dist/issuance-flow-test.js -o experimental-prometheus-rw - k6 run -e SCENARIO_LABEL=st-present-proof-flow-smoke dist/present-proof-flow-test.js -o experimental-prometheus-rw + export K6_PROMETHEUS_RW_SERVER_URL=http://localhost:9090/api/v1/write + export K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM=true + cd "${SCRIPT_DIR}"/../../tests/performance-tests/agent-performance-tests-k6 + yarn install + yarn webpack + k6 run -e SCENARIO_LABEL=st-create-prism-did-smoke dist/create-prism-did-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-credential-offer-smoke dist/credential-offer-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-credential-definition-smoke dist/credential-definition-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-credential-schema-smoke dist/credential-schema-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-did-publishing-smoke dist/did-publishing-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-connection-flow-smoke dist/connection-flow-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-issuance-flow-smoke dist/issuance-flow-test.js -o experimental-prometheus-rw + k6 run -e SCENARIO_LABEL=st-present-proof-flow-smoke dist/present-proof-flow-test.js -o experimental-prometheus-rw ) diff --git a/tests/performance-tests/agent-performance-tests-k6/.env b/tests/performance-tests/agent-performance-tests-k6/.env index 4b8958681d..0f9249eb0c 100644 --- a/tests/performance-tests/agent-performance-tests-k6/.env +++ b/tests/performance-tests/agent-performance-tests-k6/.env @@ -1,3 +1,3 @@ -PRISM_AGENT_VERSION=1.30.1-SNAPSHOT +AGENT_VERSION=1.32.1-SNAPSHOT PRISM_NODE_VERSION=2.2.1 VAULT_DEV_ROOT_TOKEN_ID=root diff --git a/tests/performance-tests/agent-performance-tests-k6/run.sh b/tests/performance-tests/agent-performance-tests-k6/run.sh index e4b4198482..b836832198 100755 --- a/tests/performance-tests/agent-performance-tests-k6/run.sh +++ b/tests/performance-tests/agent-performance-tests-k6/run.sh @@ -139,13 +139,13 @@ echo "K6 downloaded" cd "$AGENT_DIR" ##sbt docker:publishLocal -PRISM_AGENT_VERSION=$(cut -d '"' -f 2 version.sbt) +AGENT_VERSION=$(cut -d '"' -f 2 version.sbt) ## back to performance folder cd "$PERF_DIR" # set version to env file -sed -i.bak "s/PRISM_AGENT_VERSION=.*/PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION}/" "${ENV_FILE}" && rm -f "${ENV_FILE}.bak" +sed -i.bak "s/AGENT_VERSION=.*/AGENT_VERSION=${AGENT_VERSION}/" "${ENV_FILE}" && rm -f "${ENV_FILE}.bak" # create agents in parallel createIssuer & diff --git a/tests/performance-tests/agent-performance-tests-k6/src/common/Config.ts b/tests/performance-tests/agent-performance-tests-k6/src/common/Config.ts index 75fb009140..08ed0f2f92 100644 --- a/tests/performance-tests/agent-performance-tests-k6/src/common/Config.ts +++ b/tests/performance-tests/agent-performance-tests-k6/src/common/Config.ts @@ -1,49 +1,49 @@ -/*global __ENV*/ +/* global __ENV */ /** * Maximum number of iterations for the waiting loop. * If not provided, the default value is 100. */ -export const WAITING_LOOP_MAX_ITERATIONS = Number(__ENV.MY_USER_AGENT) || 1000; +export const WAITING_LOOP_MAX_ITERATIONS = Number(__ENV.MY_USER_AGENT) || 1000 /** * Pause interval in seconds for each iteration of the waiting loop. * If not provided, the default value is 10 milliseconds. */ -export const WAITING_LOOP_PAUSE_INTERVAL = Number(__ENV.WAITING_LOOP_PAUSE_INTERVAL) || 0.1; +export const WAITING_LOOP_PAUSE_INTERVAL = Number(__ENV.WAITING_LOOP_PAUSE_INTERVAL) || 0.1 /** * URL for the Issuer agent. - * If not provided, the default value is "http://localhost:8080/prism-agent". + * If not provided, the default value is "http://localhost:8080/cloud-agent". */ -export const ISSUER_AGENT_URL = __ENV.ISSUER_AGENT_URL || "http://localhost:8080/prism-agent"; +export const ISSUER_AGENT_URL = __ENV.ISSUER_AGENT_URL || 'http://localhost:8080/cloud-agent' /** * API key for the Issuer agent. * If not provided, the default value is an empty string. */ -export const ISSUER_AGENT_API_KEY = __ENV.ISSUER_AGENT_API_KEY || ""; +export const ISSUER_AGENT_API_KEY = __ENV.ISSUER_AGENT_API_KEY || '' /** * URL for the Holder agent. - * If not provided, the default value is "http://localhost:8090/prism-agent". + * If not provided, the default value is "http://localhost:8090/cloud-agent". */ -export const HOLDER_AGENT_URL = __ENV.HOLDER_AGENT_URL || "http://localhost:8090/prism-agent"; +export const HOLDER_AGENT_URL = __ENV.HOLDER_AGENT_URL || 'http://localhost:8090/cloud-agent' /** * API key for the Holder agent. * If not provided, the default value is an empty string. */ -export const HOLDER_AGENT_API_KEY = __ENV.HOLDER_AGENT_API_KEY || ""; +export const HOLDER_AGENT_API_KEY = __ENV.HOLDER_AGENT_API_KEY || '' /** * URL for the Verifier agent. - * If not provided, the default value is "http://localhost:8100/prism-agent". + * If not provided, the default value is "http://localhost:8100/cloud-agent". */ -export const VERIFIER_AGENT_URL = __ENV.VERIFIER_AGENT_URL || "http://localhost:8100/prism-agent"; +export const VERIFIER_AGENT_URL = __ENV.VERIFIER_AGENT_URL || 'http://localhost:8100/cloud-agent' /** * API key for the Verifier agent. * If not provided, the default value is an empty string. */ -export const VERIFIER_AGENT_API_KEY = __ENV.VERIFIER_AGENT_API_KEY || ""; +export const VERIFIER_AGENT_API_KEY = __ENV.VERIFIER_AGENT_API_KEY || '' diff --git a/tests/performance-tests/agent-performance-tests/README.md b/tests/performance-tests/agent-performance-tests/README.md index 3770c34f0c..c7b1318a5c 100644 --- a/tests/performance-tests/agent-performance-tests/README.md +++ b/tests/performance-tests/agent-performance-tests/README.md @@ -27,7 +27,7 @@ For example, running `ConnectionSimulation` from `simulations` package: ## Environments configuration There are multiple configuration environment variables available through `common.Configuration` module: -* `ISSUER_AGENT_URL`: URL for Issuer Agent, example: `http://localhost:8080/prism-agent` +* `ISSUER_AGENT_URL`: URL for Issuer Agent, example: `http://localhost:8080/cloud-agent` * `ISSUER_AGENT_API_KEY`: access key for Issuer agent if hosted on remote env -* `HOLDER_AGENT_URL`: URL for Holder Agent, example: `http://localhost:8090/prism-agent` +* `HOLDER_AGENT_URL`: URL for Holder Agent, example: `http://localhost:8090/cloud-agent` * `HOLDER_AGENT_API_KEY`: access key for Holder agent if hosted on remote env