Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore/quality gate/release guidelines: updated docs to align with TRGs #255

Merged
merged 3 commits into from
May 10, 2024
Merged

chore/quality gate/release guidelines: updated docs to align with TRGs #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d30f00
chore(update): updated and renamed readmes in docs folder
saudkhan116 May 7, 2024
1e1ff75
chore(update): updated interoperability guide
saudkhan116 May 7, 2024
dc61e70
chore(removed): removed ArgoCD deployment specific readme, updated re…
saudkhan116 May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In particular, the appliction is used to access the battery passport data provid

Here is a preview from the DPP App UI, where we visualize a test battery passport in this case.

![General Info View](./docs/arc42/media/GraphicBatteryPassportViewGeneralInfo.png)
![General Info View](./docs/architecture/media/GraphicBatteryPassportViewGeneralInfo.png)

> **Note**: For more information check the [documentation section](./docs/README.md)

Expand All @@ -57,18 +57,19 @@ To get started you can have a look into our documentation:

| Name | Description |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Arc42](./docs/arc42/Arc42.md) | Main Architecture Document (Arc42) of Digital Product Pass Application |
| [Administration Guide](./docs/admin%20guide/AdminGuide.md) | Administration Guide explaining the infrastructure and how to configure the application |
| [Data Retrieval Guide](./docs/data%20retrieval%20guide/DataRetrievalGuide.md) | Guide on how to retrieve data from the Catena-X Network as the Digital Product Pass |
| [Arc42](./docs/architecture/Arc42.md) | Main Architecture Document (Arc42) of Digital Product Pass Application |
| [Interoperability](./docs/interoperability/InteroperabilityGuide.md) | Interoperability document of Digital Product Pass Application |
| [Data Sovereignty](./docs/data-sovereignty/PolicyConfigGuide.md) | Data Sovereignty document of Digital Product Pass Application |
| [Administration Guide](./docs/admin/AdminGuide.md) | Administration Guide explaining the infrastructure and how to configure the application |
| [Data Retrieval Guide](./docs/data-retrieval/README.md) | Guide on how to retrieve data from the Catena-X Network as the Digital Product Pass |
| [Backend Documentation](./dpp-backend/digitalproductpass/README.md) | Backend documentation Product Passport App |
| [Deployment in Argo CD](./deployment/README.md) | Technical Guide - Deployment in ArgoCD - integration environment |
| [Docker Overview](./deployment/local/iam/README.md) | Overview on general docker commands |
| [Keycloak Overview](./deployment/local/iam/README.md) | This guide describes how to setup a keycloak instance in local docker forcontainer and import existing realm.json file. |
| [Short Introduction into the project](./docs/GETTING-STARTED.md) | Digital Product Pass App infrastructure, helm installation guide, technical usage guide |
| [Code Scaning with Kics and Trivy](./docs/infrastructure%20as%20code/IaC.md) | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github |
| [Code Scaning with Kics and Trivy](./docs/security/infrastructure-as-code/IaC.md) | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github |
| [Release Guidelines](./docs/RELEASE.md) | Digital Product Pass App Release Guide |
| [Secret Management](./docs/secrets%20management/SECRETS_MANAGEMENT.md) | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens |
| [End User Manual](./docs/user%20manual/UserManual.md) | End User Manual Product Viewer App |
| [Secret Management](./docs/security/secrets-management/SecretsManagement.md) | Secrets management to store client credentials, database passwords, access tokens |
| [End User Manual](./docs/user/UserManual.md) | End User Manual Product Viewer App |
| [Postman Overview](./deployment/local/postman//README.md) | Technical guide depicts the battery pass end-to-end API calls through the postman REST client |
| [Changelog](./CHANGELOG.md) | Changelog |
| [Helm Charts](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/charts/digital-product-pass) | Project's Helm Charts |
Expand Down
111 changes: 0 additions & 111 deletions charts/digital-product-pass/values-beta.yaml
View file
Open in desktop

This file was deleted.

112 changes: 0 additions & 112 deletions charts/digital-product-pass/values-dev.yaml
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions charts/digital-product-pass/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ backend:
name: "dpp-backend"
image:
repository: docker.io/tractusx/digital-product-pass-backend
pullPolicy: Always
pullPolicy: IfNotPresent
# -- Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry)
imagePullSecrets: []

Expand All @@ -56,7 +56,7 @@ backend:
nginx.ingress.kubernetes.io/ssl-passthrough: "false"
nginx.ingress.kubernetes.io/backend-protocol: "HTTP"
hosts:
- host: &hostname "localhost"
- host: &hostname ""
paths:
- path: /
pathType: Prefix
Expand Down Expand Up @@ -263,7 +263,7 @@ frontend:
name: "dpp-frontend"
image:
repository: docker.io/tractusx/digital-product-pass-frontend
pullPolicy: Always
pullPolicy: IfNotPresent
# -- Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry)
imagePullSecrets: []

Expand Down
Loading