Resoto UI

Deprecation Note

Resoto UI is no longer actively developed and maintained. Please visit Fix, the asset inventory for your cloud security posture.

Table of contents

• Overview
• How to get the UI running
• Join the Community
• License

Overview

First things first: This readme is still very short. We are working on full-on documentation for the UI right now.

Resoto UI is a web-based WASM application that runs in most browsers (we recommend Chrome) and was built using the Godot Engine. The Resoto UI connects to a running Resoto Core - so if you want to use the UI, you need Resoto first.

The UI has four main features to make using Resoto easier:

• Customizable dashboards (Historic data via Prometheus and live data via Resoto)
• Exploring your infrastructure via search. Navigate via fast and easy navigation.
• Change your Resoto configuration via a comfortable and powerful configuration editor
• Have simple and fast access to the Resoto Shell via a Terminal emulator (very basic though)

Of course, we already work on more features, especially rendering and navigating a visual graph!

How to use the Resoto UI

The UI ships as part of the Resoto Docker image and is then served at <resotocore-address>:8900/ui/.

To use a standalone version follow these steps:

• Download Godot 3.5 (standard version).
• Start the engine and import the project in the Project Manager (click import, select the 'project.godot' file).
• Open the project from the Project Manager.
• Run the Project by clicking on the Play button in the upper right corner or by pressing F5.

Creating a Release

1) Change the version in the repo and open a version bump PR.

The version number must be changed in two files:

resotoui\resotoui\__init__.py -> __version__ = "X.Y.Z"

src\scripts\autoloads\global.gd -> var ui_version:String= X.Y.Z

2) Create a new Release on GitHub

Just create a new release, the title of the release is always vX.Y.Z while the tag is just X.Y.Z. (e.g. Title: v3.3.3, Tag: 3.3.3)

3) Create a PR in the Resoto repo to bump the UI version

You need to change the UI version (resotoui==X.Y.X) accordingly here:

• requirements-all.txt
• requirements-extra.txt
• requirements-test.txt
• requirements.txt

Then open a pull request with the change.

Contact

Join our Discord if you have any questions or want to chat about Resoto or Resoto UI - or open a GitHub issue if you encounter problems and/or bugs.

License

Copyright 2022 Some Engineering Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.