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.

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

README.MD created #41

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Infra-editor
![](https://img.shields.io/github/package-json/v/th2-net/th2-infra-editor-v2)
![](https://img.shields.io/github/workflow/status/th2-net/th2-infra-editor-v2/build%20&%20publish%20release%20image%20to%20ghcr.io)

This is a web app that displays schemas, boxes and dictionaries and allows to edit them.

# API
This app needs `th2-infra-mgr 1.5.2` backend component to function. It should be accessible at `{infra-editor-path}/backend/*`

# Configuration
To include this component in your schema, a following yml file needs to be created
```
apiVersion: th2.exactpro.com/v1
kind: Th2CoreBox
metadata:
name: infra-editor
spec:
image-name: ghcr.io/th2-net/th2-infra-editor-v2
image-version: 2.0.14 // change this line if you want to use a newer version
type: th2-infra-editor-v2
extended-settings:
chart-cfg:
ref: schema-stable
path: custom-component
service:
enabled: false
targetPort: 80
nodePort: '31276'
resources:
limits:
memory: 15Mi
cpu: 200m
requests:
memory: 10Mi
cpu: 20m

```

# Screenshots
![picture](screenshot.png)
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.