Skip to content

Commit 56deb1b

Browse files
committed
added docs
1 parent b2c9350 commit 56deb1b

File tree

1 file changed

+50
-7
lines changed

1 file changed

+50
-7
lines changed

handover/README.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,23 +116,24 @@ Now the usual process to update the Piveau UI looks like this:
116116
* The github workflow builds a new image
117117
* We reference the new image within the `piveau-ui.yaml`
118118

119-
The piveau UI utilizes submodules to reference to the public piveau-ui project. As submodules are rather complicated and error prone, I helped myself with a small workaround: Instead of using the submodule I simply git clone the current state of the project in the correct repository. Up until now this works and it should work in the future as well.
119+
The piveau UI utilizes submodules to reference to the public piveau-ui project. As submodules are rather complicated and error prone, I helped myself with a small workaround: Instead of using the submodule I simply git clone the current state of the project in the correct repository. Up until now this works and it should work in the future as well.ƒ
120120

121121
### Integration Environment
122122

123123
The integration environment is completly managed in Flux. So everything you need, can be found within the [ionos-infrastructure](https://github.com/POSSIBLE-X/ionos-infrastructure) repository.
124124

125-
## Participants
125+
126+
#### Participants
126127

127128
Under `apps/integration-environment/participants/overlays` you will find every participants configuration.
128129
All participant share the common resources and a base configuration for its own services.
129130
The participants are sorted within the respective use cases.
130131

131-
### Adding Participants
132+
##### Adding Participants
132133

133134
If you want to add a new participant you will have have to perform the following steps:
134135

135-
#### Setup an Ionos Account
136+
###### Setup an Ionos Account
136137

137138
For this we utilize terraform. The respective file can be found under `terraform/variables.tf`.
138139
Simply append an entry with the following format
@@ -146,15 +147,29 @@ Simply append an entry with the following format
146147

147148
Once committed to origin a github action will run and aplly the terraform changes. Congrats! You now have a namespace of the name `int-{uc_descriptor}-{participant_name}`. In it exists an `ionos-secret` with the dcd credentials.
148149

149-
#### Create a New Participant Overlay
150+
###### Create a New Participant Overlay
150151

151152
That step is straight forward: Copy an existing participants file into a new file (please store it accordingly within the overlays).
152153
Usually you will now only have to replace the previous use-case-descriptor within the file with the new own. Same with the participant name.
153154

154-
#### Add the Participant to Flux
155+
###### Add the Participant to Flux
155156

156157
There exists a file `clusters/possible-x/use-case-envs.yaml`. Simply add an entry there with your new participants file as reference.
157158

159+
#### Deleting Offers
160+
161+
Once we had the task to remove all offers from the EDC database.
162+
There exist two solutions for this problem:
163+
]
164+
- You simply kill the database, using psql. The EDC will setup the db anew ojn a restart
165+
- You unreference all resources within the `kustomization.yaml` of the participant. This will delete all relevant resources. After flux is done with this, you may revert that change and have a freshly installed environment. Please note that this will neither remove the S3 service nor the Access Keys
166+
167+
#### Reseting Main Portal
168+
169+
Similar to the Offer deletion you may
170+
- Delete the DB on the Postgres Service
171+
- Unreference and rereference DB service to delete the PVC
172+
158173
### Additional Tools
159174

160175
#### Grafana
@@ -163,11 +178,39 @@ There exists a file `clusters/possible-x/use-case-envs.yaml`. Simply add an entr
163178

164179
#### PG Admin
165180

181+
It was asked by the developers to setup a PG Admin environment for the Deployment
182+
166183

167184
## Future Improvements
168185

169186
Here is a list of things that may improve the overall
170187

171-
- Remove the Helm Charts entirely - it would be good to migrate the Dev Deployment Process to
188+
### Remove the Helm Charts entirely
189+
190+
It would be good to migrate the Dev Deployment Process to the
191+
kustomize approach as well.
192+
The biggest problems here would probably be that there
193+
would be small changes in the setup, as the current status has both
194+
the consumer and the provider edc in the same namespace.
195+
196+
Another challenge might be the PG Admin setup. It retrieves the
197+
DB passwords from the secrets in its namespace. If the namespace
198+
should split up, this might be a little bit more challenging. Maybe a setup with a dedicated service role could be helpful here.
199+
This might be an interesting opportunity to add the database access to the int environment as well.
200+
201+
### Automate the Provisioning of the EDCs
202+
203+
In theory there would be ways to automatically create and setup new Participants for the Int environment.
204+
205+
Here I want to illustrate a possible way to reach that goal. There will still be issues to figure out and all of this requires a solution for autorization for the acceptance process and authentication of the user:
206+
207+
The basic steps are
208+
- setup the S3 Bucket
209+
- create and configure the participant
210+
- communicate relevant credentials (e.g. the IONOS DCD creds)
211+
212+
This could be implemented for example by triggering a git commit on acceptance. The commit could add the relevant entry to the terraform file and add a new participant to the list of participants. For details see the paragraph about adding participant in this doc.
172213

214+
The init job of the participant could be enhanced to send the relevant credentials on creation.
173215

216+
This approach would utilize the existing infrastructure and still allow for a gitops apprach.

0 commit comments

Comments
 (0)