Skip to content
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
45 changes: 24 additions & 21 deletions docs/admin-guide/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ The Configuration page consolidates key system settings and administrative confi

### 1. White Labeling

Customize the Torque interface with your organization's branding by uploading a custom logo. This ensures a **consistent and professional** look throughout the platform.
Customize the <ProductName /> interface with your organization's branding by uploading a custom logo. This ensures a **consistent and professional** look throughout the platform.

This feature allows you to:
- Replace the default Torque logo across the system.
- Replace the default <ProductName /> logo across the system.
- Upload three logo types: Favicon, Wide Logo, and Square Logo.

**How to upload your logo**
Expand Down Expand Up @@ -55,51 +55,52 @@ This feature allows you to create and manage announcement banners to notify user

### 3. Audit Logs

Torque’s **Audit Logs** provide comprehensive tracking of key platform activities, helping you monitor user behavior, investigate security risks, and maintain compliance.
<ProductName />’s **Audit Logs** provide comprehensive tracking of key platform activities, helping you monitor user behavior, investigate security risks, and maintain compliance.
Options include:
- ElasticSearch: With built-in **Elastic Stack integration**, you can forward audit data for real-time analysis and reporting.
- Torque Audit: Forward logs to Torque, and retain for 18 months..
- <ProductName /> Audit: Forward logs to <ProductName />, and retain for 18 months..

**How to set up an Audit Log destination**
📖 Learn more about [Torque Audit](/governance/audit-log/audit-log-configuration)
📖 Learn more about [<ProductName /> Audit](/governance/audit-log/audit-log-configuration)

info 🔒 Audit log integration is available for **Enterprise plans only** and requires a specific licensing feature.

---

### 4. Copilot Settings

Enable Torque’s AI-powered assistant to provide recommendations and enhance workflow automation, within your account.
Enable <ProductName />’s AI-powered assistant to provide recommendations and enhance workflow automation, within your account.

These settings include 2 features:
**1. Torque Copilot** – Easily navigate Torque with our AI chatbot, always accessible and leveraging the official documentation for swift exploration.
**1. <ProductName /> Copilot** – Easily navigate <ProductName /> with our AI chatbot, always accessible and leveraging the official documentation for swift exploration.
(This feature is based on a 3rd party tool called DocsBot)
![DocsBot](/img/docsbot.png)

**How to enable Torque Copilot**
**How to enable <ProductName /> Copilot**

1. Navigate to **Configuration > Copilot Settings**.
2. Toggle on the ‘Torque Copilot’ toggle to show the AI chatbot button at the top header, next to the rest of the utilities.
2. Toggle on the ‘<ProductName /> Copilot’ toggle to show the AI chatbot button at the top header, next to the rest of the utilities.
3. Toggle off to hide the AI chatbot and to prevent access from all users.

**2. Cloud Copilot** – Your internal AI assistance to create and customize Blueprints, auto-generate descriptions, and resolve live environment errors.
This AI assistant tool is subject to the [Torque MSA](https://www.quali.com/legal-torque-master-subscription-agreement/) and requires user consent.
This AI assistant tool is subject to the [<ProductName /> MSA](https://www.quali.com/legal-torque-master-subscription-agreement/) and requires user consent.

With this feature you can:
- **Auto-generate descriptions** for blueprints, to effortlessly expand the details on every blueprint in the account.
- **(Blueprint) Cloud Copilot** - Create and customize blueprints from your Building Blocks Library, using simple language prompts and the power of AI.
![Cloud Copilot](/img/cloud_copilot_panel.png)
![Cloud Copilot](/img/cloud_copilot_panel.png)

- **AI Insights** - Get AI assistant when you need it. Resolve issues in live environments, by clicking the “Get AI Insights” button, on every error log in your environment.
![AI Insights](/img/ai_insights.png)
- **AI Insights** - Get AI assistant when you need it. Resolve issues in live environments, by clicking the “Get AI Insights” button, on every error log in your environment.

![AI Insights](/img/ai_insights.png)



**How to Enable Cloud Copilot**

1. Navigate to **Configuration > Copilot Settings**.
2. Under the ‘Cloud Copilot’ section > click on the **‘AI Provider’ button** to select where to host your AI Data while using Copilot:
- Host in **Torque’s Open AI
- Host in **<ProductName />’s Open AI
**There’s no further configuration, just click ‘Connect’
- Host in your own **Azure OpenAI service
**You’ll have to provide: API key, Endpoint URL, GPT-4o deployment name, and GPT-4o mini deployment name.
Expand Down Expand Up @@ -133,16 +134,18 @@ info 🔒 SSO Login is optionally available for **Enterprise plans only**.

### 6. Email Reports
Subscribe to the ‘Weekly Digest’, a summary email providing key account activity insights.
Torque's weekly digest reports condense the most important information from a week's worth of data collected in Torque, making it easier for Torque administrators to quickly understand the most critical developments.
Torque ‘Weekly Digest’ emails are being sent to Torque administrators and will highlight:
<ProductName />'s weekly digest reports condense the most important information from a week's worth of data collected in <ProductName />, making it easier for administrators to quickly understand the most critical developments.
The <ProductName /> ‘Weekly Digest’ emails are being sent to administrators and will highlight:

- Cloud usage
- Torque users activity
- Users activity
- Environments usage
- Cloud Cost
- Top used IaC modules
- Top contributors to the operation

Example:

![Weekly Digest Example](/img/mockup_weekly_digest.png)

**How to Enable Email Reports**
Expand Down Expand Up @@ -187,9 +190,9 @@ When enabled by the account admin:

### 9. Experimental Features

Experimental Features give account administrators early access to upcoming capabilities in Torque that are still in development. These features are in a **beta** or **testing phase** and may not yet be fully supported or stable.
Experimental Features give account administrators early access to upcoming capabilities in <ProductName /> that are still in development. These features are in a **beta** or **testing phase** and may not yet be fully supported or stable.

This settings gives **Torque administrators early visibility and hands-on access** to major upcoming features and UI changes—allowing them to explore, prepare, and influence what’s coming before it rolls out to all users.
This settings gives **<ProductName /> administrators early visibility and hands-on access** to major upcoming features and UI changes—allowing them to explore, prepare, and influence what’s coming before it rolls out to all users.


**What You Need to Know**
Expand All @@ -199,7 +202,7 @@ This settings gives **Torque administrators early visibility and hands-on access
- 📆 Each experiment includes a defined **trial period** with a description of what’s new.
- 📩 Admins can provide feedback via:
-> A **survey form** linked within the experiment.
-> A **support ticket** submitted through the Torque support system.
-> A **support ticket** submitted through the <ProductName /> support system.


**How to Use Experimental Features**
Expand All @@ -218,7 +221,7 @@ Once the experiment ends:
- You’ll receive updates in the product and via release notes.


🛠 **Note**: Enabling experimental features is a great way to influence Torque’s roadmap and help improve future releases.
🛠 **Note**: Enabling experimental features is a great way to influence <ProductName />’s roadmap and help improve future releases.

info 🔒 Experimental Features are optionally available for **Enterprise plans only**.

Expand Down
6 changes: 3 additions & 3 deletions docs/admin-guide/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 6
title: Credentials
---

The Torque __Credentials__ store is a built-in capability for Torque to securely store your Public Cloud authentication details in order for CloudFormation and Terraform type grains to securely access them. Credentials are similar in usage to [Parameters](/admin-guide/params), but unlike parameters which are single-value, credentials are specialized objects that contain multiple values with different structure depending on the credential type. Torque Credentials are supported for AWS (role based and access key based) and Azure (secret based) authentication.
The <ProductName /> __Credentials__ store is a built-in capability for <ProductName /> to securely store your Public Cloud authentication details in order for CloudFormation and Terraform type grains to securely access them. Credentials are similar in usage to [Parameters](/admin-guide/params), but unlike parameters which are single-value, credentials are specialized objects that contain multiple values with different structure depending on the credential type.<ProductName /> Credentials are supported for AWS (role based and access key based) and Azure (secret based) authentication.

__To add a credential:__

Expand All @@ -13,7 +13,7 @@ __To add a credential:__
1. Give the credential a name and optionally a description.
2. Select the cloud provider (AWS / Azure).
3. Select the credential type and enter the authentication details.
* For AWS, role assumption and access key credentials are supported. Make sure you have a Role Arn that allows Torque access. For details, see the [Get Role ARN and external ID](#get-role-arn-and-external-id) section below.
* For AWS, role assumption and access key credentials are supported. Make sure you have a Role Arn that allows <ProductName /> access. For details, see the [Get Role ARN and external ID](#get-role-arn-and-external-id) section below.
> ![Locale Dropdown](/img/aws-provider-details.png)
* For Azure, only Service Principle Client ID and Secret are supported.
> ![Locale Dropdown](/img/azure-provider-details.png)
Expand All @@ -34,7 +34,7 @@ Once created, you can reference the credentials in the grain's ```authentication

3. In the navigation pane of the IAM console, select __Roles__, and then click __Create Role__.
1. From __Select trusted entity__, choose __AWS Account__.
2. Under An AWS account ID, select __An AWS account__ and enter 349148204654. (This is the Torque AWS account from which we will query the cost).
2. Under An AWS account ID, select __An AWS account__ and enter 349148204654. (This is the <ProductName /> AWS account from which we will query the cost).
3. Select __Require external ID__.
4. Enter an __External ID__ of your choosing. The External Id will be used to validate the Consumer of the ARN Role. __Keep note of the external ID as you will need it later in the configuration step__.
5. In __Next:Permissions__, select the policy you have just created in step 1 for cost exploration permission.
Expand Down
8 changes: 4 additions & 4 deletions docs/admin-guide/input-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Input Sources
# Input Sources

## Overview
The **Input Sources** feature is a significant enhancement for Torque users, providing a more dynamic and flexible way to retrieve and manage input values from external data sources. Whether you're dealing with multiple S3 buckets or preparing for future integrations with other external sources, this feature streamlines your workflow and ensures your configurations are always up-to-date.
The **Input Sources** feature is a significant enhancement for <ProductName /> users, providing a more dynamic and flexible way to retrieve and manage input values from external data sources. Whether you're dealing with multiple S3 buckets or preparing for future integrations with other external sources, this feature streamlines your workflow and ensures your configurations are always up-to-date.
During the launch environment process, this feature simplifies the handling of multiple data sources by using a single configuration template, and allowing real-time listing of S3 bucket objects.

## Key Benefits
Expand Down Expand Up @@ -110,15 +110,15 @@ Below is an example SVG diagram illustrating the architecture for using an HTTP

### Creating an Input Source

Torque role: Account admin
<ProductName /> role: Account admin

:::tip __Important__
Modifying or deleting an Input Source may cause blueprints that use the Input Source to fail.
:::

#### General Steps

1. **Navigate to Input Sources:** Access the Input Sources section in your Torque Account Settings.
1. **Navigate to Input Sources:** Access the Input Sources section in your <ProductName /> Account Settings.
2. **Add New Source:** Click on the "Connect a new Input Source" button.
3. **Select preferred provider:** Choose between AWS S3 bucket, Azure Blob Storage, or HTTP Server.

Expand Down Expand Up @@ -193,7 +193,7 @@ Modifying or deleting an Input Source may cause blueprints that use the Input So

### Using an Input Source in Blueprints

Torque role: Space Developer
<ProductName /> role: Space Developer

To use an input source in a blueprint:

Expand Down
8 changes: 4 additions & 4 deletions docs/admin-guide/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 15
title: Notifications
---

Torque Notifications enable space admins to define notifications for environment lifecycle events and environment owner/collaborator changes. The notifications will be sent to your email address, Teams or Slack chats, or the automation tool of your choice. You can define multiple notifications for different communication tools, and for different channels in the same communication tool.
<ProductName /> Notifications enable space admins to define notifications for environment lifecycle events and environment owner/collaborator changes. The notifications will be sent to your email address, Teams or Slack chats, or the automation tool of your choice. You can define multiple notifications for different communication tools, and for different channels in the same communication tool.

Supported events:

Expand Down Expand Up @@ -35,8 +35,8 @@ Supported events:
**Space Events:**
* Agent Disconnected

__To configure Torque notifications:__
1. In Torque, access the suitable space.
__To configure <ProductName /> notifications:__
1. In <ProductName />, access the suitable space.
2. Click __Settings > Notifications__.
3. Click __+ Add Notification__.
4. Select the suitable communication tool (Slack, Teams, or generic webhook).
Expand All @@ -49,6 +49,6 @@ __To configure Torque notifications:__
* This step is not needed for Email, as we'll configure the notifications to be sent to the logged-in user's email address.
7. For generic webhooks, optionally provide a token from the tool to send with the notification, and select the desired event to test.
8. Test the configuration.
9. Click __Send Test Message__ and make sure you receive a Torque notification message in the chat or generic tool.
9. Click __Send Test Message__ and make sure you receive a <ProductName /> notification message in the chat or generic tool.
10. Click __Select Notifications__ to select the notifications to send.
11. Click __Apply__.
8 changes: 4 additions & 4 deletions docs/admin-guide/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ sidebar_position: 2
title: Parameters
---

The Torque parameter store is a repository of key-value pairs, which can be used and reused in blueprint YAMLs across all spaces in Torque. Two types of parameters are supported:
* Account-level parameters are defined by the Torque account admin and can be used across all spaces. As such, these parameters are typically used to store data that applies to multiple spaces.
The <ProductName /> parameter store is a repository of key-value pairs, which can be used and reused in blueprint YAMLs across all spaces in <ProductName />. Two types of parameters are supported:
* Account-level parameters are defined by the <ProductName /> account admin and can be used across all spaces. As such, these parameters are typically used to store data that applies to multiple spaces.
* Space-level parameters are defined by space admins and apply to specific spaces.

## Creating Account-level parameters

Torque role: Account admin
<ProductName /> role: Account admin

:::tip __Important__
Modifying or deleting a parameter may cause blueprints that use the parameter to fail.
Expand All @@ -31,7 +31,7 @@ __To add an account-level parameter:__

## Creating space-level parameters

Torque role: Space admin
<ProductName /> role: Space admin

__To add a space-level parameter:__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
sidebar_position: 1
title: Using Self-Managed source control providers
---
Torque can integrate with any source control provider, whether it's a public SaaS platform (e.g., github.com) or a self-managed instance running on your premises. When using a self-managed source control provider, the communication between Torque and the source control server is fully contained within your site, happening between the Torque agent installed on your cluster and the source control server installed on your premises.
<ProductName /> can integrate with any source control provider, whether it's a public SaaS platform (e.g., github.com) or a self-managed instance running on your premises. When using a self-managed source control provider, the communication between <ProductName /> and the source control server is fully contained within your site, happening between the <ProductName /> agent installed on your cluster and the source control server installed on your premises.

> ![Self-Hosted Repositories](/img/self-hosted-repos.png)


There are three steps when configuring Torque to read from a self-hosted source control provider:
There are three steps when configuring <ProductName /> to read from a self-hosted source control provider:

1. **Install an Agent**
2. **Generate a Personal Access Token**
3. **Add your repositories to Torque** (Can be done from the Torque UI, API, or Torque Terraform Provider)
3. **Add your repositories to <ProductName />** (Can be done from the <ProductName /> UI, API, or <ProductName /> Terraform Provider)


See the following sections with specific details how to configure each self-managed source control provider:
Expand All @@ -21,4 +21,4 @@ See the following sections with specific details how to configure each self-mana
3. [BitBucket Enterprise (on-premise)](/admin-guide/source-control/Self%20Hosted%20Repositories/self-managed-bitbucket)
4. Azure Repositories on-premise - Supported, Please contact support for detailed instructions

With a self-managed source control provider configured in Torque, you can securely manage and version control your assets stored in your on-premises source control system, while keeping all communication within your network boundaries.
With a self-managed source control provider configured in <ProductName />, you can securely manage and version control your assets stored in your on-premises source control system, while keeping all communication within your network boundaries.
Loading