-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Merge branch rel-10.1 with rel-10.0 #24554
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -144,13 +144,99 @@ The *Logs* tab allows you to view all logs for both CLI and C# applications. To | |||||
|
|
||||||
| ## Tools | ||||||
|
|
||||||
| The *Tools* tab allows you to easily access to the user interfaces of the tools you are using. A *tool* may be related with a docker container, or independent. If it is related with a container (ex: *grafana*), the tool is opened when the container is up. If the tool is independent, it will be always opened. | ||||||
| The *Tools* tab provides quick access to web-based management interfaces for infrastructure services like Grafana, RabbitMQ, pgAdmin, and Redis Commander. Each tool opens in a dedicated browser tab within ABP Studio, eliminating the need to switch between external browser windows. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| The microservice template comes with pre-defined tools to display related container user interfaces. You can edit existing tools, add new tools or delete existing tools. | ||||||
| The microservice template includes pre-configured tools for common infrastructure services. You can customize these tools or add new ones based on your project requirements. | ||||||
|
|
||||||
| In the example below, a new tool named `My Application Status` will be added to the tools and it will display the URL in the input: | ||||||
| ### Adding a New Tool | ||||||
|
|
||||||
| To add a new tool, click the *+* button in the *Tools* tab. This opens the *Create Tool* dialog where you can configure the tool properties. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### Tool Properties | ||||||
|
|
||||||
| Each tool has the following configurable properties: | ||||||
|
|
||||||
| | Property | Required | Description | | ||||||
| |----------|----------|-------------| | ||||||
| | **Name** | Yes | A unique identifier displayed as the tab header. | | ||||||
| | **URL** | Yes | The web interface URL (e.g., `http://localhost:3000`). | | ||||||
| | **Related Container** | No | Docker container name. When set, the tool activates only when this container is running. | | ||||||
| | **Related Kubernetes Service** | No | A regex pattern to match Kubernetes service names for automatic URL switching. | | ||||||
| | **Related Kubernetes Service Port** | No | The port to use when connecting via Kubernetes service. | | ||||||
|
|
||||||
| ### Editing and Removing Tools | ||||||
|
|
||||||
| - **Edit**: Right-click on a tool tab and select *Edit* to modify its properties. | ||||||
| - **Remove**: Right-click on a tool tab and select *Close* to remove it from the profile. | ||||||
| - **Clear Cookies**: Right-click on a tool tab and select *Clear Cookies* to reset the browser session for that tool. | ||||||
|
|
||||||
| ### Tool Activation States | ||||||
|
|
||||||
| Tools can be in different activation states depending on their configuration: | ||||||
|
|
||||||
| | State | Condition | Behavior | | ||||||
| |-------|-----------|----------| | ||||||
| | **Always Active** | No *Related Container* specified | Tool is always accessible regardless of container state. | | ||||||
| | **Container-Dependent** | *Related Container* specified | Tool activates only when the specified Docker container is running. | | ||||||
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified | Tool URL switches between local and Kubernetes endpoints automatically. | | ||||||
|
||||||
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified | Tool URL switches between local and Kubernetes endpoints automatically. | | |
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified (optionally with *Related Container*) | Tool URL switches between local and Kubernetes endpoints automatically. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description states "A unique identifier displayed as the tab header" but it doesn't clarify whether this name must be unique across all tools or just within the current profile. Consider clarifying this to avoid confusion.