Skip to content

Commit 74037d0

Browse files
AdurilAduril
committed
added dashboard stuff
1 parent c0a20a5 commit 74037d0

File tree

178 files changed

+32936
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

178 files changed

+32936
-0
lines changed

‎.github/workflows/build-demo-stuff.yaml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: CD
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
env:
8+
REGISTRY: ghcr.io
9+
jobs:
10+
build-consumer-connector:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: read
14+
packages: write
15+
steps:
16+
- uses: actions/checkout@v4
17+
name: checkout
18+
19+
- name: Docker "connector" meta
20+
id: consumer-connector-meta
21+
uses: docker/metadata-action@v4
22+
with:
23+
images: ghcr.io/possible-x/connector
24+
tags: |
25+
type=raw,value=dashboard-demo-consumer,enable=true
26+
- name: Build and push "connector"
27+
id: build_and_push_connector
28+
uses: docker/build-push-action@v4
29+
with:
30+
context: ./dashboard/deployment/connector
31+
file: ./dashboard/deployment/connector/Dockerfile.consumer
32+
push: true
33+
tags: ${{ steps.consumer-connector-meta.outputs.tags }}
34+
labels: ${{ steps.consumer-connector-meta.outputs.labels }}
35+
cache-from: type=gha
36+
cache-to: type=gha,mode=max

‎dashboard/CHANGELOG.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file - formatted and maintained according to the rules
4+
documented on <http://keepachangelog.com>.
5+
6+
This file will not cover changes about documentation, code clean-up, samples, or the CI pipeline. With each version
7+
(respectively milestone), the core features are highlighted. Relevant changes to existing implementations can be found
8+
in the detailed section referring to by linking pull requests or issues.
9+
10+
## [Unreleased]
11+
12+
### Overview
13+
14+
### Detailed Changes
15+
16+
#### Added
17+
18+
#### Changed
19+
20+
#### Removed
21+
22+
#### Fixed

‎dashboard/CODEOWNERS

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# This file provides an overview of responsibilities in this repository.
2+
3+
# Please note that this file does not represent all contributions to the code. What persons and organizations
4+
# actually contributed to each file can be seen on GitHub and is documented in the license headers.
5+
6+
# Each line is a file pattern followed by one or more contact persons. The last matching pattern has the most precedence.
7+
# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.
8+
9+
# The linked persons are automatically added as reviewers when a pull request is opened.
10+
11+
LICENSE @paullatzelsperger
12+
13+
.github/actions/ @paullatzelsperger
14+
.github/ISSUE_TEMPLATE @paullatzelsperger
15+
.github/workflows/ @paullatzelsperger

‎dashboard/CODE_OF_CONDUCT.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Microsoft Open Source Code of Conduct
2+
3+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4+
5+
Resources:
6+
7+
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8+
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9+
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

‎dashboard/Dockerfile

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Stage 1: Compile and Build angular codebase
2+
FROM node:lts as build
3+
4+
ARG BASE_PATH=/
5+
6+
WORKDIR /app
7+
COPY ./ /app/
8+
RUN npm install
9+
RUN npm run build -- --base-href=$BASE_PATH
10+
11+
# Stage 2: Serve app with nginx
12+
FROM nginx:alpine
13+
COPY --from=build /app/deployment/nginx.conf /etc/nginx/nginx.conf
14+
COPY --from=build /app/dist/edc-demo-client /usr/share/nginx/html
15+
COPY --from=build /app/src/assets /usr/share/nginx/html/assets
16+
EXPOSE 80
17+
18+
HEALTHCHECK --interval=2s --timeout=5s --retries=10 \
19+
CMD curl -f http://localhost/ || exit 1

‎dashboard/LICENSE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎dashboard/README.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# EDC Data Dashboard
2+
3+
**Please note: This repository does not contain production-grade code and is only intended for demonstration purposes.**
4+
5+
EDC Data Dashboard is a dev frontend application for [EDC Management API](https://github.com/eclipse-edc/Connector).
6+
7+
## Documentation
8+
9+
Developer documentation can be found under [docs/developer](docs/developer/), where the main concepts and decisions are captured as [decision records](docs/developer/decision-records/).
10+
11+
## Running the frontend locally
12+
Should you want to run the frontend on your development machine, you'll have to configure some backend values. Those are stored in `app.config.json`, and
13+
by default contain the following:
14+
15+
```json
16+
{
17+
"managementApiUrl": "{{managementApiUrl}}",
18+
"catalogUrl": "{{catalogUrl}}",
19+
"storageAccount": "{{account}}",
20+
"storageExplorerLinkTemplate": "storageexplorer://v=1&accountid=/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/providers/Microsoft.Storage/storageAccounts/{{account}}&subscriptionid={{subscriptionId}}&resourcetype=Azure.BlobContainer&resourcename={{container}}",
21+
}
22+
```
23+
Substitute the values as necessary:
24+
- `apiKey`: enter here what your EDC instance expects in th `x-api-key` header
25+
- `catalogUrl`: prepend your connector URL, e.g. `http://localhost`, assuming your catalog endpoint is exposed at port 8181, which is the default
26+
- `managementApiUrl`: prepend your connector URL, e.g. `http://localhost`, assuming your IDS endpoint is exposed at port 9191
27+
- `storageAccount`: insert the name of an Azure Blob Storage account to which the connector has access, otherwise data transfers won't work.
28+
29+
**Be extra careful NOT to commit those changes, as they might leak potentially sensitive information!!!**
30+
31+
As some extra safety consider running `git udpate-index --assume-unchanged src/assets/config/app.config.json` before changing this file.
32+
33+
## Running a frondend and two connectors locally (for demo purpose)
34+
To test the correct functionality locally you can spin up a local docker compose
35+
that will load two `data-dashboard`s service and two `connector`s, one for consumer
36+
and one for provider.
37+
38+
Just start the docker compose.
39+
```shell
40+
docker compose up
41+
```
42+
43+
Consumer data-dashboard will be available at `http://localhost:18080`
44+
Provider data-dashboard will be available at `http://localhost:28080`
45+
46+
### Running DataDashboard from the host machine (for debugging purpose)
47+
To have a quicker development cycle, you can also run the DataDashboard from the
48+
host machine using `npm start`, sending request against the connector loaded by
49+
docker compose.
50+
First you need to change the `app.config.json` this way:
51+
```json
52+
{
53+
...
54+
"managementApiUrl": "http://localhost:4200/management",
55+
"catalogUrl": "http://localhost:4200/management",
56+
...
57+
}
58+
```
59+
60+
Then start the local DataDashboard:
61+
```shell
62+
npm start
63+
```
64+
65+
The DataDashboard will be available at `http://localhost:4200`
66+
67+
## Deploy to Azure
68+
69+
Create a resource group and container registry:
70+
71+
```bash
72+
export RESOURCE_GROUP=edc-data-dashboard
73+
export ACR_NAME=edcdatadashboard
74+
az group create --resource-group $RESOURCE_GROUP --location westeurope -o none
75+
az acr create --resource-group $RESOURCE_GROUP --name $ACR_NAME --sku Standard --location westeurope --admin-enabled -o none
76+
```
77+
78+
Dockerize the application and push it to the registry by running:
79+
80+
```bash
81+
az acr build --registry $ACR_NAME --image edc-showcase/edc-data-dashboard:latest .
82+
```
83+
84+
The docker image is now ready to be deployed to Azure Container Instances (ACI). The `app.config.json` file contains configuration which is fetched by the application at startup. This file can be overridden at deployment time by mounting a secret on `assets/config`. For each deployment you need to provide the corresponding connector backend URL, the storage account name and the API key using this secret. Deploy to ACI using the following command:
85+
86+
```bash
87+
export CONNECTOR_DATA_URL=<CONNECTOR_DATA_URL>
88+
export CONNECTOR_CATALOG_URL=<CONNECTOR_CATALOG_URL>
89+
export STORAGE_ACCOUNT=<STORAGE_ACCOUNT>
90+
export API_KEY=<API_KEY>
91+
92+
# deploy to ACI (when prompted for credentials use the username/password as available in Azure Portal: ACR->Access Keys)
93+
az container create --image ${ACR_NAME}.azurecr.io/edc-showcase/edc-data-dashboard:latest \
94+
--resource-group $RESOURCE_GROUP \
95+
--name edc-data-dashboard \
96+
--secrets "app.config.json"="{\"managementApiUrl\": \"$CONNECTOR_DATA_URL\", \"catalogUrl\": \"$CONNECTOR_CATALOG_URL\", \"storageAccount\": \"$STORAGE_ACCOUNT\", \"apiKey\": \"$API_KEY\"}" \
97+
--secrets-mount-path /usr/share/nginx/html/assets/config \
98+
--dns-name-label edc-data-dashboard
99+
```
100+
101+
## Contributing
102+
103+
See [how to contribute](https://github.com/eclipse-edc/docs/blob/main/CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)