Skip to content

Commit

Permalink
deploy: 7973e2b
Browse files Browse the repository at this point in the history
  • Loading branch information
@ds-mmaul
ds-mmaul committed Jan 29, 2024
1 parent dea1367 commit eaa7719
Show file tree
Hide file tree
Showing 58 changed files with 945 additions and 55 deletions.
56 changes: 56 additions & 0 deletions docs/adminguide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,62 @@ Enables <true> or disables <false> pgadmin4 console for the PostgreSQL dat
Enables <true> or disables <false> a K8S Ingress for the pgadmin4 console
## Portal Configuration
The following process is required to successfully connect to the portal:
### Company Registration
[How To](https://portal.int.demo.catena-x.net/documentation)
#### Additional info
Each instance of trace-x reflects an own company, which is associated with one BPN.
### User Registration
[How To](https://portal.int.demo.catena-x.net/documentation/)
#### Additional info
The user registration is a self service. Each user can have one or multiple trace-x roles assigned.
### Connector Registration
[How To](https://portal.int.demo.catena-x.net/documentation/)
#### Additional info
A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.
### App Registration
[How To](https://portal.int.demo.catena-x.net/documentation/)
#### Additional info
A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.
### Create App Subscription
[How To](https://portal.int.demo.catena-x.net/documentation/)
#### Additional info
An app subscription is necessary to be able to setup a frontend url which will be authorized through keycloak and accessible with the portal.
### Activate App Subscription
[How To](https://portal.int.demo.catena-x.net/documentation/)
#### Additional info
The app subscription needs to be activated from all instances which want to participate in the trace-x use case.
### Retrieve Wallet Configuration
[How To](https://portal.int.demo.catena-x.net/documentation/)
## Troubleshooting
Coming soon...
87 changes: 86 additions & 1 deletion docs/administration/administration-guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,7 @@ <h1>Administration Guide</h1>
<ul class="sectlevel2">
<li><a href="#_frontend_configuration">Frontend Configuration</a></li>
<li><a href="#_backend_configuration">Backend Configuration</a></li>
<li><a href="#_portal_configuration">Portal Configuration</a></li>
</ul>
</li>
<li><a href="#_troubleshooting">Troubleshooting</a></li>
Expand Down Expand Up @@ -1581,6 +1582,90 @@ <h5 id="_pgadmin4_ingress_enabled">&lt;pgadmin4.ingress.enabled&gt;</h5>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_portal_configuration">Portal Configuration</h3>
<div class="paragraph">
<p>The following process is required to successfully connect to the portal:</p>
</div>
<div class="sect3">
<h4 id="_company_registration">Company Registration</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info">Additional info</h5>
<div class="paragraph">
<p>Each instance of trace-x reflects an own company, which is associated with one BPN.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_user_registration">User Registration</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info_2">Additional info</h5>
<div class="paragraph">
<p>The user registration is a self service. Each user can have one or multiple trace-x roles assigned.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_connector_registration">Connector Registration</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info_3">Additional info</h5>
<div class="paragraph">
<p>A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_app_registration">App Registration</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info_4">Additional info</h5>
<div class="paragraph">
<p>A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_create_app_subscription">Create App Subscription</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info_5">Additional info</h5>
<div class="paragraph">
<p>An app subscription is necessary to be able to setup a frontend url which will be authorized through keycloak and accessible with the portal.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_activate_app_subscription">Activate App Subscription</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect4">
<h5 id="_additional_info_6">Additional info</h5>
<div class="paragraph">
<p>The app subscription needs to be activated from all instances which want to participate in the trace-x use case.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_retrieve_wallet_configuration">Retrieve Wallet Configuration</h4>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
Expand All @@ -1594,7 +1679,7 @@ <h2 id="_troubleshooting">Troubleshooting</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-23 10:20:34 UTC
Last updated 2024-01-29 07:09:56 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/backend-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1168,7 +1168,7 @@ <h3 id="_pgadmin4_ingress_enabled">&lt;pgadmin4.ingress.enabled&gt;</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-23 10:20:34 UTC
Last updated 2024-01-29 07:09:56 UTC
</div>
</div>
</body>
Expand Down
99 changes: 98 additions & 1 deletion docs/administration/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,17 @@ <h1>Configuration</h1>
<li><a href="#_helm_configuration_trace_x_backend_values_yaml">Helm configuration Trace-X Backend (values.yaml)</a></li>
</ul>
</li>
<li><a href="#_portal_configuration">Portal Configuration</a>
<ul class="sectlevel2">
<li><a href="#_company_registration">Company Registration</a></li>
<li><a href="#_user_registration">User Registration</a></li>
<li><a href="#_connector_registration">Connector Registration</a></li>
<li><a href="#_app_registration">App Registration</a></li>
<li><a href="#_create_app_subscription">Create App Subscription</a></li>
<li><a href="#_activate_app_subscription">Activate App Subscription</a></li>
<li><a href="#_retrieve_wallet_configuration">Retrieve Wallet Configuration</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -1222,10 +1233,96 @@ <h4 id="_pgadmin4_ingress_enabled">&lt;pgadmin4.ingress.enabled&gt;</h4>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_portal_configuration">Portal Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following process is required to successfully connect to the portal:</p>
</div>
<div class="sect2">
<h3 id="_company_registration">Company Registration</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info">Additional info</h4>
<div class="paragraph">
<p>Each instance of trace-x reflects an own company, which is associated with one BPN.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_user_registration">User Registration</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info_2">Additional info</h4>
<div class="paragraph">
<p>The user registration is a self service. Each user can have one or multiple trace-x roles assigned.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_connector_registration">Connector Registration</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info_3">Additional info</h4>
<div class="paragraph">
<p>A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_app_registration">App Registration</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info_4">Additional info</h4>
<div class="paragraph">
<p>A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_create_app_subscription">Create App Subscription</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info_5">Additional info</h4>
<div class="paragraph">
<p>An app subscription is necessary to be able to setup a frontend url which will be authorized through keycloak and accessible with the portal.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_activate_app_subscription">Activate App Subscription</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
<div class="sect3">
<h4 id="_additional_info_6">Additional info</h4>
<div class="paragraph">
<p>The app subscription needs to be activated from all instances which want to participate in the trace-x use case.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_retrieve_wallet_configuration">Retrieve Wallet Configuration</h3>
<div class="paragraph">
<p><a href="https://portal.int.demo.catena-x.net/documentation/">How To</a></p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-23 10:20:34 UTC
Last updated 2024-01-29 07:09:56 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/frontend-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ <h4 id="_readinessprobe">&lt;readinessProbe&gt;</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-23 10:20:34 UTC
Last updated 2024-01-29 07:09:56 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ <h2 id="_deployment_using_argocd">Deployment using ArgoCD</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-23 10:20:34 UTC
Last updated 2024-01-29 07:09:56 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit eaa7719

Please sign in to comment.