Skip to content
Snippets Groups Projects
Verified Commit 4e05f25b authored by Lucas Briese's avatar Lucas Briese
Browse files

chore: fix markdown indent size was 4 instead of 2

parent 63544bb9
No related branches found
No related tags found
1 merge request!45kubernetes history annotation empty username
...@@ -467,6 +467,8 @@ ij_kotlin_wrap_expression_body_functions = 1 ...@@ -467,6 +467,8 @@ ij_kotlin_wrap_expression_body_functions = 1
ij_kotlin_wrap_first_method_in_call_chain = false ij_kotlin_wrap_first_method_in_call_chain = false
[{*.markdown,*.md}] [{*.markdown,*.md}]
indent_size = 2
indent_style = space
ij_markdown_force_one_space_after_blockquote_symbol = true ij_markdown_force_one_space_after_blockquote_symbol = true
ij_markdown_force_one_space_after_header_symbol = true ij_markdown_force_one_space_after_header_symbol = true
ij_markdown_force_one_space_after_list_bullet = true ij_markdown_force_one_space_after_list_bullet = true
......
...@@ -3,21 +3,23 @@ ...@@ -3,21 +3,23 @@
This guide is written for an average developer which read the [Install & Setup Guide](install_and_setup.md). This guide is written for an average developer which read the [Install & Setup Guide](install_and_setup.md).
![Architecture Overview](img/architecture.svg) ![Architecture Overview](img/architecture.svg)
*Figure 1: Architecture overview* _Figure 1: Architecture overview_
- In this document we focus on parts we have control of and some that we do not (1) - In this document we focus on parts we have control of and some that we do not (1)
- backend, *Data Provider* - backend, _Data Provider_
- backend, *KPI Database* - backend, _KPI Database_
- frontend, *Dashboard*, *nginx* - frontend, _Dashboard_, _nginx_
- OpenCoDE *Gitlab API* (1) - OpenCoDE _Gitlab API_ (1)
- OpenCoDE *Tool result API* (1) - OpenCoDE _Tool result API_ (1)
Scope: Scope:
1. How to retrieve the state of the deployed system? 1. How to retrieve the state of the deployed system?
2. How to interact with it? 2. How to interact with it?
3. Which tasks require contact with whom? 3. Which tasks require contact with whom?
Out of Scope: Out of Scope:
1. How to install and setup? [Install & Setup Guide](install_and_setup.md) 1. How to install and setup? [Install & Setup Guide](install_and_setup.md)
2. How to extend the system? [Development Guide](development_guide.md) 2. How to extend the system? [Development Guide](development_guide.md)
3. Fix common issues? [Troubleshooting Guide](troubleshooting.md) 3. Fix common issues? [Troubleshooting Guide](troubleshooting.md)
...@@ -27,19 +29,20 @@ Out of Scope: ...@@ -27,19 +29,20 @@ Out of Scope:
## How to check system state ## How to check system state
- To get a quick overview of current pods & container use the venv command `dev-status`, `prod-status` - To get a quick overview of current pods & container use the venv command `dev-status`, `prod-status`
- *Data Provider* provides a health endpoint that summarizes the state of all external systems. This is the easiest way to test the connection to all systems. - _Data Provider_ provides a health endpoint that summarizes the state of all external systems. This is the easiest way to test the connection to all systems.
1. We use it as [startupProbe](../kubernetes/scripts/startupProbe.sh) in [dev](../kubernetes/dev/deployment.yaml) & [prod](../kubernetes/prod/deployment.yaml) deployment. It is required to succeed at least once for a successful deployment. 1. We use it as [startupProbe](../kubernetes/scripts/startupProbe.sh) in [dev](../kubernetes/dev/deployment.yaml) & [prod](../kubernetes/prod/deployment.yaml) deployment. It is required to succeed at least once for a successful deployment.
2. You can attach to the *Data Provider* container as described in [kubernetes section](#how-to-attach-to-the-running-container) 2. You can attach to the _Data Provider_ container as described in [kubernetes section](#how-to-attach-to-the-running-container)
3. And use the verbose script `/kubernetes/scripts/startupProbe.sh` [startupProbe.sh](../kubernetes/scripts/startupProbe.sh) 3. And use the verbose script `/kubernetes/scripts/startupProbe.sh` [startupProbe.sh](../kubernetes/scripts/startupProbe.sh)
4. [For details check the logs](#how-to-retrieve-logs-of-the-running-application) 4. [For details check the logs](#how-to-retrieve-logs-of-the-running-application)
- For the *Dashboard* you can check: - For the _Dashboard_ you can check:
- prod: https://sec-kpi.opencode.de/ - prod: https://sec-kpi.opencode.de/
- dev: https://dev-kpi.o4oe.de - dev: https://dev-kpi.o4oe.de
- Other OpenCoDE systems are covered via *Data Provider* healthcheck, [for details of the following contact WizardTales](mailto://magic@wizardtales.com): - Other OpenCoDE systems are covered via _Data Provider_ healthcheck, [for details of the following contact WizardTales](mailto://magic@wizardtales.com):
- *Gitlab API*, *Tool result API* - _Gitlab API_, _Tool result API_
- *KPI Database* - _KPI Database_
- *nginx* (not covered in healthcheck) - _nginx_ (not covered in healthcheck)
## What you need to know about kubernetes ## What you need to know about kubernetes
...@@ -49,12 +52,12 @@ Out of Scope: ...@@ -49,12 +52,12 @@ Out of Scope:
- We lack some permissions e.g. describe and event; you will need `-o yaml` or `-o json` for certain information - We lack some permissions e.g. describe and event; you will need `-o yaml` or `-o json` for certain information
- Commands provided are in format `command with venv`: `explicit command without venv usage` - Commands provided are in format `command with venv`: `explicit command without venv usage`
- [There are 2 namespace:](https://kommone.cva-12889ja7.wizardtales.net/dashboard/c/c-gqst2/explorer/projectsnamespaces) - [There are 2 namespace:](https://kommone.cva-12889ja7.wizardtales.net/dashboard/c/c-gqst2/explorer/projectsnamespaces)
- Namespace *dev*: *fraunhofer* - Namespace _dev_: _fraunhofer_
- Namespace *prod*: *fraunhoferprod* - Namespace _prod_: _fraunhoferprod_
- General hints for kubernetes: - General hints for kubernetes:
- Deployment := 0..n pods (on *dev* usually 1) - Deployment := 0..n pods (on _dev_ usually 1)
- Pod := 1..n containers - Pod := 1..n containers
- e.g. *b-deployment* can have the pod *b-deployment-123456789-12345* which has the container *b-container* - e.g. _b-deployment_ can have the pod _b-deployment-123456789-12345_ which has the container _b-container_
- General commands you will use: - General commands you will use:
- `kubectl get [pod <podname>|pods|deployment b-deployment|deployments] [-o json]` - `kubectl get [pod <podname>|pods|deployment b-deployment|deployments] [-o json]`
- `kubectl exec -it pod` - `kubectl exec -it pod`
...@@ -95,7 +98,7 @@ Out of Scope: ...@@ -95,7 +98,7 @@ Out of Scope:
- [Get pod & container names](#how-to-get-pod-and-container-names) - [Get pod & container names](#how-to-get-pod-and-container-names)
- Log command supports `[-f|--follow]` and `[--since=0s|--since=2m]` - Log command supports `[-f|--follow]` and `[--since=0s|--since=2m]`
- *Data Provider*, *Dashboard* - _Data Provider_, _Dashboard_
- `dev logs pods/<pod> -c <container>`: `kubectl --namespace=fraunhofer logs pods/<pod> -c <container>` - `dev logs pods/<pod> -c <container>`: `kubectl --namespace=fraunhofer logs pods/<pod> -c <container>`
- `prod logs pods/<pod> -c <container>`: `kubectl --namespace=fraunhoferprod logs pods/<pod> -c <container>` - `prod logs pods/<pod> -c <container>`: `kubectl --namespace=fraunhoferprod logs pods/<pod> -c <container>`
- *KPI Database*,*Gitlab API*, *Tool result API* are currently not accessible directly; they're under the control of *WizardTales* - _KPI Database_,_Gitlab API_, _Tool result API_ are currently not accessible directly; they're under the control of _WizardTales_
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.