Skip to content
Merged
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
9 changes: 6 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ jobs:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci
- name: Modify Config File
run: |
cp docusaurus-prod.config.js docusaurus.config.js
- name: Build website
run: npm run build

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ jobs:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: rojopolis/spellcheck-github-actions@0.33.1
- uses: actions/checkout@v4
- uses: rojopolis/spellcheck-github-actions@0.38.0
name: Spellcheck
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20
cache: npm

- name: Install dependencies
Expand Down
13 changes: 12 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ PaaS
microservice
Crossplane
RBAC
rbac
onboarding
prem
Quicklinks
Expand Down Expand Up @@ -519,4 +520,14 @@ toolchain
CRD
tradeoffs
roadmap
roadmap
FQDN
Shopify
IPs
terragrunt
py
js
txt
Terraform's
TPUs
FPGAs
VPN
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/admin-guide/input-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ More usage examples can be found [here](/blueprint-designer-guide/blueprints/blu
This example demonstrates how to list S3 buckets and RDS instances per account in AWS using a simple Flask server.

**Notes:**
1. The example is built for demo purposes with some hardcoded values and is meant to be deployed in playground environments.
1. The example is built for demo purposes with some hard-coded values and is meant to be deployed in playground environments.
2. A service account with the proper AWS role is pre-created for assuming roles in other accounts, passed in the `role_arn` query parameter to the server.

**Deployment Details:**
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ __To add an account-level parameter:__
* __Value__: Parameter’s value
* __Description__: Informative description of the parameter or value it contains
4. Click __Apply__.
The parameter is stored in the parameter store and can be used in your blueprint YAMLs in the format: ```{{.params.param-name}}```. For details, see [Parameters](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#parameterss).
The parameter is stored in the parameter store and can be used in your blueprint YAMLs in the format: ```{{.params.param-name}}```. For details, see [Parameters](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#parameters).

## Creating space-level parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/source-control/source-control-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In this article:

## Ensure your account is added to the GitHub organization you're connecting

1. Go to [https://github.com/orgs/{YOUR_ORG}/people](https://github.com/orgs/{YOUR_ORG}/people).
1. Go to [https://github.com/orgs/\{YOUR_ORG\}/people](https://github.com/orgs/\{YOUR_ORG\}/people).
2. Make sure your user is listed in the organization. If not, make sure the user is added as a member with global read access.

## Ensure your organization has granted access to Torque
Expand Down
4 changes: 2 additions & 2 deletions docs/blueprint-designer-guide/Autogenerated Blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Torque currently supports only simple types as blueprint inputs for Helm (string

- **commands**: A list of Helm commands to run before installing the chart.
No need to specify the Helm command itself.
e.g, for the command "helm plugin install [options] <path|url>... [flags] " type "plugin install [options] <path|url>... [flags]".
e.g, for the command "helm plugin install [options] `<path|url>`... [flags] " type "plugin install [options] `<path|url>`... [flags]".

```jsx title="For example:"
inputs:
Expand All @@ -52,7 +52,7 @@ If you have dependencies, add the command `dep up`.

In this section, we'll learn how to edit our auto-generated blueprints in Torque. While Torque conveniently auto-generated blueprints out of your assets, these blueprints may be missing some minor details, like the cluster namespace and execution agent to use, Terraform version, Helm commands to run, etc.

:::tip__Note__
:::tip __Note__
Torque only saves the latest version. So if you need versioning, you're welcome to add the modified blueprint to your __/blueprints__ repository.
:::

Expand Down
13 changes: 4 additions & 9 deletions docs/blueprint-designer-guide/blueprint-quickstart-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ sidebar_position: 1
title: Blueprint Design
---

In this article:
- [What is a Torque blueprint?](#what-is-a-torque-blueprint)
- [Option A: Let Torque generate blueprints from your assets](#option-a-let-torque-generate-blueprints-from-your-assets)
- [Option B: Create a multi-asset blueprint in your source control repository](#option-b-create-a-multi-asset-blueprint-in-your-source-control-repository)
- [Example multi-grain blueprint 2: Web-game on S3 (using CloudFormation and Terraform)](#example-multi-grain-blueprint-2-web-game-on-s3-using-cloudformation-and-terraform)

## What is a Torque blueprint?
A blueprint is a template for provisioning an environment that contains references to different IaC Components ("Grains") that together define the applications, cloud infrastructure, networking and policies that make up a specific environment to be deployed. Blueprints are stored as source-controlled YAML files, and each grain in a blueprint is a reference to one IaC or automation file (for example, a Terraform module or a Helm chart) that will be deployed as part of the environment, and the component's designated inputs, outputs and execution information.

Expand All @@ -19,7 +13,7 @@ You can have Torque discover (i.e. generate) blueprints out of your existing Ter
## Option A: Let Torque generate blueprints from your assets
When developing a new blueprint, Torque provides you with the ability to automatically discover the different IaC and Automation assets in your connected source control repository, and generate a blueprint for a single asset (or generate multiple single-asset blueprints in one go).

These generated blueprints are stored in Torque's backend, and you can customize their inputs, outputs and other details as needed inside an embedded VSCode style IDE from within the Torque Portal. For details on what you can do with generated blueprints, see [Autogenerated Blueprints](/blueprint-designer-guide/autogenerated%20blueprints).
These generated blueprints are stored in Torque's backend, and you can customize their inputs, outputs and other details as needed inside an embedded VSCode style IDE from within the Torque Portal. For details on what you can do with generated blueprints, see [Auto-generated Blueprints](./Autogenerated%20Blueprints.md).


1. In your space, go to __Settings > Repositories__ and discover your assets.
Expand Down Expand Up @@ -75,6 +69,7 @@ grains:
source:
store: infra
path: terraform/rds
```
4. For each additional grain, do one of the following:
* Copy an example of that grain from a generated blueprint.
* Use the sample structure for that grain type in the corresponding page in [The Blueprint YAML](/blueprint-designer-guide/blueprints/blueprints-overview).
Expand All @@ -83,14 +78,14 @@ grains:
7. Customize the ```inputs``` and ```outputs``` sections of the blueprint to contain only the relevant inputs that the entire environment needs, and to reflect the outputs from the grains that you would like to make available to the environment's end-user.

## Removing a blueprint
As mentioned above, there are two types of blueprints, autogenerated blueprints (stored in Torque) and source-controlled blueprints (stored in your repository).
As mentioned above, there are two types of blueprints, auto-generated blueprints (stored in Torque) and source-controlled blueprints (stored in your repository).

To delete an auto-generated blueprint, in the **Blueprints** page, click the blueprint's more options button and select **Remove**.
> ![Locale Dropdown](/img/remove-blueprint.png)

To delete a repository blueprint, delete the blueprint file from the repository's branch that the Torque space is connected to.

### Example multi-grain blueprint 1: Helm Application with MySQL and S3 Deployed by Terraform
## Example multi-grain blueprint 1: Helm Application with MySQL and S3 Deployed by Terraform
This blueprint is available in the __Sample__ space [here](https://portal.qtorque.io/Sample/blueprints/[Sample]Helm%20Application%20with%20MySql%20and%20S3%20Deployed%20by%20Terraform), which deploys 2 Terraform modules and a Helm chart:

```jsx title=
Expand Down
6 changes: 3 additions & 3 deletions docs/blueprint-designer-guide/blueprints/ansible-grain.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ grains:
- result
```

:::tip__Note__
:::tip __Note__
The `outputs` section in the auto-generated blueprint is a placeholder. You should review and update it to match the actual outputs produced by your playbook. Since outputs depend on the playbook's content, they cannot be determined automatically during discovery.
:::

:::tip__Note__
:::tip __Note__
Always validate and adjust the generated blueprint YAML before running it, especially the `outputs` section, to ensure it behaves as expected.
:::

Expand Down Expand Up @@ -159,7 +159,7 @@ ansible-grain:
```

### `agent`
Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#host) for more details.
Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#agent) for more details.

### `inputs`
Inputs which are provided to the ansible grain will be used in the ansible command line as "extra-vars".
Expand Down
2 changes: 1 addition & 1 deletion docs/blueprint-designer-guide/blueprints/argocd-grain.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ grains:
Below are the main fields available in the ArgoCD grain `spec` section:

### `agent`
Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#host) for more details.
Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#agent) for more details.

### `deployment-engine`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Blueprint YAML Overview

Torque blueprints are reusable components designed to model a required environment from the infrastructure to the application. **Blueprint designers** utilize Torque's VSCode plugin or the Torque's self-service UI to build a YAML based imperative blueprints that aimed to fulfill business requirements in a self-service manner for their end-users.

:::tip__Note__
:::tip __Note__
Blueprints are written in YAML files that reside in a __/blueprints__ folder within a Github, Gitlab or BitBucket repository (the folder name is case-sensitive and must be "blueprints"). The __/blueprints__ folder must be defined as the blueprint repository in the space's __Settings > Repositories__ page. Blueprints file type must be ".yaml" and not ".yml".

For enhanced asset discovery and organization, see [Torque Assets Markers](/blueprint-designer-guide/torque-assets-markers).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ instructions:
source:
store: <The name of the repository which contains the instructions as it was onboarded to Torque>
path : <instructions/something.md> # path inside the repository where the instructions md file is located. Must be in a folder called "instructions".

```

:::info
Expand Down
53 changes: 26 additions & 27 deletions docs/blueprint-designer-guide/blueprints/cloudformation-grain.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,33 @@ To grant Torque the necessary permissions to successfully provision resources, y

```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "BasicBucketOperations",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<your-bucket>/*"
]
},
{
"Sid": "BasicCfnOperations",
"Effect": "Allow",
"Action": [
"cloudformation:CreateStack",
"cloudformation:DeleteStack",
"cloudformation:UpdateStack",
"cloudformation:DescribeStacks",
"cloudformation:DescribeStackEvents"
],
"Resource": "*"
}
"Version": "2012-10-17",
"Statement": [
{
]
"Sid": "BasicBucketOperations",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<your-bucket>/*"
]
},
{
"Sid": "BasicCfnOperations",
"Effect": "Allow",
"Action": [
"cloudformation:CreateStack",
"cloudformation:DeleteStack",
"cloudformation:UpdateStack",
"cloudformation:DescribeStacks",
"cloudformation:DescribeStackEvents"
],
"Resource": "*"
}
]
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The `path` must match the exact name of the CloudShell Blueprint in your CloudSh

The agent executing the CloudShell grain must have direct network connectivity to the self-hosted CloudShell instance. This includes access to CloudShell Portal API and the CloudShell orchestration services.

Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#host) for more details.
Please see [the grain agent](/blueprint-designer-guide/blueprints/blueprints-yaml-structure#agent) for more details.

### `inputs`

Expand Down
2 changes: 1 addition & 1 deletion docs/blueprint-designer-guide/blueprints/shell-grain.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
bar_position: 12
sidebar_position: 16
title: The Shell Grain
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ $TORQUE_TF_EXECUTABLE -chdir=$TORQUE_TF_MODULE_PATH state rm $1
Or

```bash
$TORQUE_TF_EXECUTABLE -chdir=$TORQUE_TF_MODULE_PATH state rm <hardcoded_resource>
$TORQUE_TF_EXECUTABLE -chdir=$TORQUE_TF_MODULE_PATH state rm <hard_coded_resource>
```

Here is another example which shows how to use the plan output in a post-tf-plan script:
Expand Down
2 changes: 1 addition & 1 deletion docs/environment-services/environment-annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ set_annotations = [{"key": "power", "value": "on"}] {

}
```
:::tip__Note__
:::tip __Note__
Currently the only supported annotations are "power:on", "power:off" and "power:torque.remove". We will add more annotations and open it for custom annotations soon.
"torque.remove" is a general annotation value which may be used with any key. It signals to Torque to remove the annotation completely from the environment. A good example of when to use it is when the environment is ended.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/environment-services/scheduled-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ resources:
quantity: '{{ .inputs.gpus }}'
```

:::tip__TIP__
:::tip __TIP__
Here are some common "Resource Types" for scheduling:

**Hardware Resources:**
Expand Down
2 changes: 1 addition & 1 deletion docs/governance/custom-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ When defining a new custom role, you will need to provide the following details:


import pic1 from '/img/custom-rbac-create-new.png';
import pic2 from '/img/custom-rbac-premissions.png';
import pic2 from '/img/custom-rbac-permissions.png';
import pic3 from '/img/custom-rbac-compare-roles.png';

> <img src={pic1} alt="custom-rbac" style={{width: 700}} />
Expand Down
4 changes: 2 additions & 2 deletions docs/governance/roles-and-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ As such, there are 4 roles in Torque:
| [Manage space notifications](/admin-guide/notifications) |Create/delete/modify target for Torque notifications for space events.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Manage space tags](/governance/tags) |Set space specific values to Tags defined by the account admin for the "space" scope.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Manage space parameters](/admin-guide/params) |Create/update/delete names and values of parameters which are available across the space.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Customize space color and icon](/getting-started/Getting starting with terraform) || ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Customize space color and icon](/getting-started/Getting%20starting%20with%20terraform) || ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Publish blueprints](/blueprint-designer-guide/blueprint-quickstart-guide) |Add/remove blueprints from the catalog.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||||
| [Manage space repositories](/getting-started/Discover%20Your%20Assets) |1. Add/remove git repositories containing Torque blueprints or IaC assets to a space.<br />2. Run discovery on the repositories to find and add assets to Torque (as auto-generated blueprints). | ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)|||
| [Manage space users and roles](#add-existing-users-to-your-space) |Add Torque users to a space and set their role in the space.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)|||
| [Manage space blueprints](/blueprint-designer-guide/blueprint-quickstart-guide) |1. Modify the contents of a blueprint that resides in Torque (not in source control) or delete it.<br />2. Edit blueprint metadata (labels, icons).| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||
| [Manage blueprint tags](governance/tags) |Set blueprint-specific values for tags defined by the account admin for the "blueprint" scope.| ![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)||
| [Manage blueprint tags](/governance/tags) |Set blueprint-specific values for tags defined by the account admin for the "blueprint" scope.| ![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)||
| Force terminate environment |Terminate a blueprint that failed normal termination while ignoring previous errors.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)||
| View agents |View the list of Torque agents connected to an account.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)|||
| View space users |View the list of users in a space.| ![Locale Dropdown](/img/green-dot.png) |![Locale Dropdown](/img/green-dot.png)|![Locale Dropdown](/img/green-dot.png)|||
Expand Down
1 change: 1 addition & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
slug: /
custom_edit_url: null
title: Welcome to Quali Torque Documentation!
sidebar_label: Welcome!
hide_table_of_contents: true

---
Expand Down
Loading