-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs[readme]: Added readme for project and Dataspace Connector
docs[Licence]: Brand licence to IDSA docs[Contributing]: Fill Contributing (copied mostly from DSC Repo) docs[Changelog]: Fill Changelog docs[Code_of_conduct]: Fill Code of Conduct (copied from DSC Repo)
- Loading branch information
1 parent
c1e30d8
commit 27bc01d
Showing
6 changed files
with
226 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
## 2021-06-16 | ||
|
||
### Added | ||
- [Readme](README.md) | ||
- [Code_of_Conduct](CODE_OF_CONDUCT.md) | ||
- [Contributing](CONTRIBUTING.md) | ||
|
||
## 2021-05 | ||
|
||
### Added | ||
- Dataspace Connector slim and full deployment examples added |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## Code of Conduct | ||
|
||
### Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
### Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
### Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
### Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
### Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), | ||
version 1.4, available at http://contributor-covenant.org/version/1/4. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Contributing to the IDS Deployment Examples | ||
|
||
|
||
This is an ongoing project of the developers of the IDSA Repositories: | ||
* [DataspaceConnector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) | ||
* [DSC-Camel-Instance](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance) | ||
* [IDS-ConfigurationManager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager) | ||
* [IDS-ConfigurationManager-UI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI) | ||
* [IDS-Messaging-Services](https://github.com/International-Data-Spaces-Association/IDS-Messaging-Services) | ||
* and anyone interested in providing deployment examples for open source IDS components. | ||
|
||
You are very welcome to contribute to this project when you find a bug, want to suggest an | ||
deployment, or have an idea for a useful feature. For this, always create an issue and a corresponding branch, and follow our style | ||
guides as described below. | ||
|
||
Please note that we have a [code of conduct](CODE_OF_CONDUCT.md) that all developers should stick to. | ||
|
||
## Changelog | ||
|
||
We document changes in the [CHANGELOG.md](CHANGELOG.md) on root level which is formatted and | ||
maintained according to the rules documented on http://keepachangelog.com. | ||
|
||
## Issues | ||
|
||
You always have to create an issue if you want to integrate a bugfix, improvement, or feature. | ||
Briefly and clearly describe the purpose of your contribution in the corresponding issue. | ||
The pre-defined [labels](#labels) improve the understanding of your intentions and help to follow | ||
the scope of your changes. | ||
|
||
**Bug Report**: As mentioned above, bug reports should be submitted as an issue. To give others | ||
the chance to reproduce the error in order to find a solution as quickly as possible, the report | ||
should at least include the following information: | ||
* Description: What did you expect and what happened instead? | ||
* Steps to reproduce (system specs included) | ||
* Relevant logs and/or media (optional): e.g. an image | ||
|
||
## Labels | ||
|
||
The [labels](https://github.com/FraunhoferISST/DataspaceConnector/labels) are listed at the | ||
[issues](https://github.com/FraunhoferISST/DataspaceConnector/issues). | ||
There are three types of labels: one describes the content of the issue and should be used by the | ||
developer that creates the issue. The other one, starting with `status`, will be added from the | ||
developer that takes on the issue. New issues should be initially marked with `status:open`. | ||
Furthermore, the issues `core-functionality` and `ids-functionality` help to specify the scope of | ||
the issue. They map the structure of the roadmap. | ||
* Basic labels: `bug`, `enhancement`, `suggestion`, `documentation` `outdated`, `question`, `discussion` | ||
* `status:closed`: issue is closed (after successful approval by issuer and QA) | ||
* `status:duplicate`: issue is a duplicate of another linked issue and therefore discontinued | ||
* `status:in-progress`: issue has been assigned and is currently being worked on | ||
* `status:on-hold`: issue may be implemented at a later date | ||
* `status:open`: issue has been submitted or re-opened recently | ||
* `status:out-of-scope`: issue is considered out of the project's scope and therefore not further considered | ||
* `status:resolved`: issue has been implemented and tested by a developer | ||
* `status:wont-fix`: issue is in scope but considered impossible or too expensive to deal with | ||
|
||
## Branches | ||
|
||
After creating an issue yourself or if you want to address an existing issue, you have to create a | ||
branch with a unique number and name that assigns it to an issue. Therefore, follow the guidelines | ||
at https://deepsource.io/blog/git-branch-naming-conventions/. After your changes, update the | ||
`README.md`, Wiki, and `CHANGELOG.md` with necessary details. Then, create a pull request and note | ||
that **committing to the main branch is not allowed**. Please use the feature `linked issues` to | ||
link issues and pull requests. | ||
|
||
## Commits | ||
|
||
We encourage all contributors to stick to the commit convention following the specification on | ||
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). In general, use the | ||
imperative in the present tense. A quick overview of the schema: | ||
``` | ||
<type>[optional scope]: <description> | ||
[optional body] | ||
[optional footer(s)] | ||
``` | ||
|
||
Types: `fix`, `feat`, `chore`, `test`, `refactor`, `docs`, `release`. Append `!` for breaking | ||
changes to a type. | ||
|
||
An example of a very good commit might look like this: `feat![login]: add awesome breaking feature` | ||
|
||
**Pay attention to never push your IDS keystore or certificate to the repository - not in a single | ||
commit!** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,44 @@ | ||
In this repository you will find example setups of IDS components. | ||
<h1 align="center"> | ||
IDS Deployment Examples | ||
<br> | ||
</h1> | ||
|
||
*UNDER CONSTRUCTION* | ||
|
||
<p align="center"> | ||
<a href="#Overview">Overview</a> • | ||
<a href="#contributing">Contribute</a> • | ||
<a href="#developers">Responsible</a> • | ||
<a href="https://github.com/International-Data-Spaces-Association/IDS-Deployment-Examples/issues">Issues</a> | ||
</p> | ||
|
||
The IDS Deployment Examples Repository is used to provide working deployments across the various IDSA repositories. This has several advantages: | ||
* The examples provide appropriately pre-built Docker, Kubernetes, Helm configurations that others can use. | ||
* It ensures that specific versions have been tested together and work together. | ||
* In addition to the actual components from the [IDS Reference Architecture Model](https://www.internationaldataspaces.org/wp-content/uploads/2019/03/IDS-Reference-Architecture-Model-3.0.pdf), combinations of components can also be provided as a setup. | ||
|
||
## Overview | ||
|
||
The repository is organized as follows: | ||
* Per component or component bundle (union from e.g. Dataspace Connector and Metadata broker or Dataspace Connector and Trusted Connector) a folder is created. This again contains possibly independent Variatonen for e.g. minimal/full Setups or Helm/Kubernetes/Docker Setups. | ||
* Additionally there is a templates folder, which provides templates for the Deployment Examples. | ||
|
||
|
||
## Contributing | ||
|
||
You are very welcome to contribute to this project when you find a bug, want to suggest an | ||
deployment, or have an idea for a useful feature. Please find a set of guidelines at the | ||
[CONTRIBUTING.md](CONTRIBUTING.md) and the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). | ||
|
||
## Developers | ||
|
||
This is an ongoing project of the developers of the IDSA Repositories: | ||
* [DataspaceConnector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) | ||
* [DSC-Camel-Instance](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance) | ||
* [IDS-ConfigurationManager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager) | ||
* [IDS-ConfigurationManager-UI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI) | ||
* [IDS-Messaging-Services](https://github.com/International-Data-Spaces-Association/IDS-Messaging-Services) | ||
* and anyone interested in providing deployment examples for open source IDS components. | ||
|
||
## License | ||
|
||
Copyright © 2020 Fraunhofer ISST. This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,15 @@ | ||
Explain the different setups and their purpose. | ||
<h1 align="center"> | ||
<br> | ||
<a href="https://dataspace-connector.de/dsc_logo.svg"><img src="https://dataspace-connector.de/dsc_logo.svg" alt="Dataspace Connector Logo" width="200"></a> | ||
<br> | ||
Dataspace Connector | ||
<br> | ||
</h1> | ||
|
||
This IDS deployment provides examples to set up the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector). | ||
We distinguish between three categories: | ||
1. **Full Setup**: The [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with all its extensions, i.e. [Configmanager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), [UI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance), Postgres DB. | ||
2. **Provider-Consumer Setup**: Here two [Dataspace Connectors](https://github.com/International-Data-Spaces-Association/DataspaceConnector) are started, so that data can be exchanged between them. (**Currently empty**) | ||
3. **Slim Setup**: In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and UI. | ||
|
||
For more details see here: [Dataspace Connector Architecture](https://international-data-spaces-association.github.io/DataspaceConnector/Documentation/Architecture) |