An open API service indexing awesome lists of open source software.

https://github.com/scality/zenko-ui

Zenko UI
https://github.com/scality/zenko-ui

artesca zenko

Last synced: 5 months ago
JSON representation

Zenko UI

Awesome Lists containing this project

README

          

# Zenko UI

[![codecov](https://codecov.io/gh/scality/zenko-ui/branch/development/1.0/graph/badge.svg?token=BRX58ZF4VJ)](https://codecov.io/gh/scality/zenko-ui)

Zenko UI is our portal to manage offline Zenko instances.

It provides a user interface for:
- Monitoring the health of the processes
- Managing storage accounts and users
- Browsing in buckets
- Managing workflows (replication, transition, expiration)
- Adding data access
- Adding storage locations
- Monitoring S3 data accesses

## How to start

### Connect to Scality VPN

The Zenko deployment runs on a VPN-accessible scality.cloud instance.

### Add entries to your local /etc/hosts file
```
NODE_IP="put-the-node-ip"

echo "$NODE_IP keycloak.zenko.local iam.zenko.local sts.zenko.local management.zenko.local s3.zenko.local" >>/etc/hosts
```

### Start Zenko UI locally
```
npm install
npm run start:dev
```

Zenko UI now uses the metalk8s common navbar:
```
git clone https://github.com/scality/metalk8s
cd metalk8s/shell-ui
docker build -t shell-ui .
docker run -d -p 8082:80 shell-ui
```

### Access UI
```
http://127.0.0.1:8383
```
must be redirected to the Keycloak login page:
```
Username or email: bartsimpson
Password: 123
```

*Note*: Keycloak uses cookies to manage user sessions. A SameSite cookie
prevents cookies from being sent in cross-site requests, to defend against
CSRF attacks. To make the local UI work, request it using a matched domain
(e.g., *.zenko.local).

## Test

```bash
npm run test
```

## Authentication
[documentation](documentation/AUTHENTICATION.md)

## Release
[documentation](documentation/RELEASE.md)