Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
evegufy committed Aug 1, 2024
1 parent a27739c commit cbfdcfb
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 41 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

This repository contains the code for the Integration layer between Digital Identity Management (DIM) solution and Tractus-X Portal written in C#. It's used to create a wallet and configure all needed information.

The SSI Dim Middle Layer is currently designed to work with the [Eclipse Tractus-X Portal](https://github.com/eclipse-tractusx/portal) in version [v2.1.0](https://github.com/eclipse-tractusx/portal/tree/portal-2.1.0). The Eclipse Tractus-X Portal is the reference implementation of the portal application for [Catena-X](https://catena-x.net).

For **installation** details and further information, please refer to the chart specific [README](./charts/dim/README.md).

## Requirements and Setup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Identity Access Management
# Identity Access Management (IAM)

## Role concept

The endpoints of the SSI Dim Middle Layer can only be used with an authenticated user. To be able to authorize the user, he needs to have the configured Audience which is set in the appsetting under `JWTBEAREROPTIONS__TOKENVALIDATIONPARAMETERS__VALIDAUDIENCE. The configured Audience **must** be added as a client in the idp.
The endpoints of the SSI Dim Middle Layer can only be used with an authenticated and authorized user. To be able to authorize the (technical) user, he needs to have the configured audience which is set in the appsettings under `JWTBEAREROPTIONS__TOKENVALIDATIONPARAMETERS__VALIDAUDIENCE`. The configured audience **must** be added as a client in the IAM system.

The following roles do exist and need to be exist in the Client that is configured as the valid audience:
The following roles need to exist in the client that is configured as the valid audience and need to be assigned to the (technical) user:

| Role | Endpoint |
|-----------------------|------------------------------------------------------|
Expand Down
6 changes: 0 additions & 6 deletions docs/admin/release-process/Release Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ The release process for a new version can roughly be divided into the following
- [Merge release branch](#merge-release-branch)
- [NOTICE](#notice)

The process builds on the [Development Flow](../dev-process/Dev-flow_git-diagram.md) which, usually, takes place within forks and leads to merged pull requests in the repositories of the eclipse-tractusx organization.

For assigning and incrementing **version** numbers [Semantic Versioning](https://semver.org) is followed.

## Preparations on the release branch
Expand All @@ -33,8 +31,6 @@ The version needs to be updated in the `src` directory within the 'Directory.Bui

Also, bump the chart and app version in the [Chart.yaml](../../../charts/dim/Chart.yaml) and the version of the images in the [values.yaml](../../../charts/dim/values.yaml).

_Consortia relevant: Update the version of the targetRevision tag in the [argocd-app-templates](../../../consortia/argocd-app-templates/), used for consortia-environments._

Example for commit message:

_build: bump version for vx.x.x_
Expand Down Expand Up @@ -77,8 +73,6 @@ _build(1.2.0): merge release into main_
>
> This workflow also pushes the version tag that triggers the [release workflow](../../../.github/workflows/release.yml) which creates the versioned docker image/s.
_Consortia relevant: The 'ssi-dim-middle-layer-x.x.x' tag is used to install (with the convenience of the argocd-app-templates) or upgrade the version via AgroCD on the consortia K8s clusters._

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
Expand Down
11 changes: 0 additions & 11 deletions docs/admin/tractus-x-portal.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/architecture/Architecture Constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,6 @@ The following document outlines the architecture constraints for the SSI Dim Mid
- **Run Anywhere**: The system is designed to be containerized and deployable as a Docker image. This ensures it can run on various platforms, including cloud environments, on-premises infrastructure, or locally.
- **Platform-Independent**: The application is platform-independent, capable of running on Kubernetes or similar orchestration platforms.

## Developer Constraints

### Open Source Software

- **Apache License 2.0**: The Apache License 2.0 is selected as the approved license to respect and guarantee intellectual property rights.

### Development Standards

- **Coding Guidelines**: Defined coding guidelines for frontend (FE) and backend (BE) development must be followed for all portal-related developments.
- **Consistency Enforcement**: Code analysis tools, linters, and code coverage metrics are used to enforce coding standards and maintain a consistent style. These standards are enforced through the Continuous Integration (CI) process to prevent the merging of non-compliant code.

## Code Analysis and Security

To ensure code quality and security, the following analyses and checks are performed during standard reviews:

### Code Quality Checks

- **Code Linting**: Tools to enforce coding style and detect syntax errors.
- **Code Coverage**: Metrics to ensure a sufficient percentage of the codebase is covered by automated tests.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/Context and scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Business Context

The Self-Sovereign Identity (SSI) dim middle layer purpose is to facilitate seamless communication with digital wallet of SAP. Being responsible for the critical functions of creating wallets and managing technical user.
The Self-Sovereign Identity (SSI) DIM Middle Layer purpose is to facilitate seamless communication with digital wallet of SAP. Being responsible for the critical functions of creating wallets and managing technical user.

## Technical Context

Expand Down
File renamed without changes.

0 comments on commit cbfdcfb

Please sign in to comment.