Skip to content

Commit ffdb128

Browse files
fix(gen): triangle concepts (#5449)
1 parent 1af9054 commit ffdb128

File tree

11 files changed

+68
-8
lines changed

11 files changed

+68
-8
lines changed

pages/account/concepts.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ A magic link provides quick and secure access to your account without the hassle
4040

4141
Multifactor authentication (MFA) is any form of verification that requires two factors to authenticate to a device you wish to connect to. Scaleway supports MFA for Cloud accounts in the form of a security code that you use in addition to your [password](#password) when you log in. You can receive the code via SMS or an authenticator app on your smartphone. Enabling MFA adds an additional layer of security against unauthorized access to your account.
4242

43+
Refer to the [How to use MFA](/account/how-to/use-2fa) documentation page for more information.
44+
4345
## Password
4446

4547
A password is a string of characters associated to your account's email address that allows you to access the [Scaleway console](https://console.scaleway.com/). It is personal and must not be shared with anyone. Alternatively, you can use a [magic link](#magic-link) to authenticate yourself.

pages/environmental-footprint/concepts.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ In the context of digital services, and more specifically cloud infrastructures
3535

3636
In short, the environmental impact is an estimated measure all the resources consumed and emissions generated by an activity or product, with the aim of minimizing negative impacts on the environment and promoting more sustainable practices.
3737

38+
Refer to the [calculation breakdown](/environmental-footprint/additional-content/environmental-footprint-calculator) documentation page for a detailed description of how the environmental impact is calculated at Scaleway.
39+
3840
## Life Cycle Analysis (LCA)
3941
Life Cycle Analysis (LCA) is a method of assessing the environmental impact of a product, service or process throughout its life cycle, from the extraction of materials to the end of life.
4042

@@ -77,4 +79,6 @@ The calculation is performed using the following formula:
7779

7880
```
7981
WUE = Total Water Used (liters) ÷ Total IT Energy Consumption (kWh)​
80-
```
82+
```
83+
84+
Refer to the [calculation breakdown](/environmental-footprint/additional-content/environmental-footprint-calculator/#water-consumption) documentation page for a detailed description of how water consumption is calculated.

pages/iam/concepts.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,16 @@ The diagram above shows how different IAM concepts mentioned on this page intera
1919

2020
A user account refers to a human who owns a Scaleway account. Your account bears your personal information and authentication methods required to access the [Scaleway console](https://console.scaleway.com/). When you create your Scaleway account, an [Organization](#organization) is automatically created with you as the designated Owner. You can also be added to an existing Organization as a Member and have an account that exists only within that Organization.
2121

22+
Refer to the [How to create an account](/account/how-to/create-an-account) documentation page for more information.
23+
2224
## Application
2325

2426
An application (also known as an IAM application) is a non-human user in an [Organization](#organization). IAM applications can be used when you want to create an API key that is not linked to a user, to give programmatic access to resources.
2527

2628
Note that applications cannot, by definition, have access to the Scaleway console, as they have only an API key and no account themselves (they are not [accounts](#account)).
2729

30+
Refer to the [Users, groups and applications](/iam/reference-content/users-groups-and-applications) and [How to manage applications](/iam/how-to/manage-applications) documentation pages for more information.
31+
2832
## API key
2933

3034
An API key is a unique identifier, used to authenticate requests made to the [Scaleway API](https://www.scaleway.com/en/developers/api/). An API key consists of an access key and a secret key. The access key is like a unique ID or username, and is not a sensitive piece of information. The secret key is more sensitive as it is like a password to authenticate the access key.
@@ -49,6 +53,8 @@ The grace period is the time an [IAM Member](#members) has to comply with the se
4953

5054
A group (also known as an IAM group) is a grouping of [users](#user) and/or [applications](#application). Creating groups allows you to attach [policies](#policy) to multiple users and/or applications at the same time.
5155

56+
Refer to the [Users, groups and applications](/iam/reference-content/users-groups-and-applications) and [How to manage groups](/iam/how-to/manage-groups) documentation pages for more information.
57+
5258
## IAM
5359

5460
**I**dentity and **A**ccess **M**anagement allows you to share access to the management of your Scaleway [resources](#resource) in a controlled and secure manner.
@@ -93,12 +99,17 @@ Permission set names contain descriptions that clearly explain their purpose. Fo
9399

94100
Permissions sets (e.g.`InstanceReadAccess`) and their [scope](#scope) (e.g. "on Project A only") make up IAM rules, which define the access rights that a [principal](#principal) (user, group, or application) should have.
95101

102+
103+
Refer to the [Permission sets](/iam/reference-content/permission-sets) reference page for an extensive list of the available permission sets.
104+
96105
## Policy
97106

98-
Policies control user rights by defining one or more [rules](#rule) to apply to the attached [principals](#principal) (users, groups, or applications). A policy rule has three parts: [permission set](#permission-set), [scope](#scope) and [conditions](#conditions).
107+
Policies control user rights by defining one or more [rules](#rule) to apply to the attached [principals](#principal) (users, groups, or applications). A policy rule has two parts: [permission set](#permission-set), [scope](#scope) and [conditions](#conditions).
99108

100109
For each policy rule, you specify one or more permission sets (e.g. "list all Instances") and their scope (e.g. "on Project A only"). This therefore defines the actions that the principles can carry out on resources within the scope.
101110

111+
Refer to the [Understanding IAM Policies](/iam/reference-content/policy) and the [How to manage a policy](/iam/how-to/manage-policies) documentation pages for more information.
112+
102113
## Preferred Project
103114

104115
You can carry out actions on Scaleway Object Storage resources either via the [Scaleway console](https://console.scaleway.com), or via a third-party API or CLI, such as [the AWS CLI](/object-storage/api-cli/object-storage-aws-cli/), [MinIOClient](/object-storage/api-cli/installing-minio-client/) or [Rclone](/object-storage/api-cli/installing-rclone/). While the Scaleway console gives you the option to specify the [Scaleway Project](/organizations-and-projects/concepts/#project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard Amazon S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. See our page on [using API keys with Object Storage](/iam/api-cli/using-api-key-object-storage/) for more information.
@@ -115,6 +126,8 @@ Projects are groupings of Scaleway [resources](#resource). Every Scaleway Organi
115126

116127
For example, if IAM users within your [Organization](#organization) are working on building two different systems with Scaleway resources, you can group the resources for each system into different Projects. This then allows you to restrict [IAM users'](#user) access to only the Project they are working on. It also facilitates the separation of billing between Projects.
117128

129+
Refer to the [How to create a Project](/organizations-and-projects/how-to/create-a-project) documentation page for more information.
130+
118131
## Resource
119132

120133
A Scaleway resource is either a product or a feature in the Scaleway Ecosystem. Examples of resources include Instances, Private Networks, Kubernetes Kapsule and Flexible IPs, to name a few.
@@ -152,4 +165,6 @@ A user (also known as an IAM user) is a human user in an Organization. They can
152165
- **Owner**: You are the Owner of the [Organization](#organization) that was created with your account.
153166
- **Member**: You are a Member when you are added to an Organization by an Owner or user with IAM Manager permissions. Members exist only within the specific Organizations in which they are created.
154167

155-
Within each Organization, different IAM users can have different rights (defined through [policies](#policy)) to perform actions on resources.
168+
Within each Organization, different IAM users can have different rights (defined through [policies](#policy)) to perform actions on resources.
169+
170+
Refer to the [Users, groups and applications](/iam/reference-content/users-groups-and-applications) reference page for more information.

pages/managed-databases-for-postgresql-and-mysql/api-cli/setting-up-encryption-at-rest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ dates:
77
posted: 2024-12-19
88
---
99

10-
Encryption at rest allows you to permanently encrypt your database data. The data is encrypted at volume level using [LUKS](https://en.wikipedia.org/wiki/Linux_Unified_Key_Setup). The management of the encryption key is done by Scaleway.
10+
[Encryption at rest](/managed-databases-for-postgresql-and-mysql/concepts/#encryption-at-rest) allows you to permanently encrypt your database data. The data is encrypted at volume level using [LUKS](https://en.wikipedia.org/wiki/Linux_Unified_Key_Setup). The management of the encryption key is done by Scaleway.
1111

1212
The feature can be activated upon Database Instance creation via the console and the API, or after creation exclusively through the API with the [upgrade endpoint](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/#path-database-instances-upgrade-a-database-instance).
1313

pages/managed-databases-for-postgresql-and-mysql/concepts.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ A Database Instance is a managed database service created upon a custom base ima
4040

4141
A [snapshot](/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots/) is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data.
4242

43+
Refer to the [How to manage snapshots](/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots/) documentation page for more information.
44+
4345
## Encryption at rest
4446

4547
<Message type="important">
@@ -56,6 +58,7 @@ Encryption at rest can be activated after Database Instance creation via the [up
5658

5759
Enabling encryption means your database data will be copied into a new, encrypted block volume. This takes approximately 1 hour per 100 GB of storage. When switching volumes, expect a few seconds of downtime towards the end of the copying process.
5860

61+
Refer to the [Encryption at rest performance benchmark](/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots/) reference page to find a benchmark of the performance of Scaleway Managed Databases performing encryption at rest.
5962

6063
## Endpoint
6164

@@ -65,6 +68,9 @@ A point of connection to a database. The endpoint is associated with an IPv4 add
6568

6669
A database engine is the software component that stores and retrieves your data from a database. Currently, PostgreSQL versions 9.6, 10, 11, 12, 13, 14, and 15 are available. MySQL is available in version 8.
6770

71+
Refer to the [PostgreSQL version updates](/managed-databases-for-postgresql-and-mysql/reference-content/pg-version-updates/) reference page for a list of PostreSQL version updates and the corresponding features that are supported at Scaleway.
72+
73+
6874
## High availability
6975

7076
Is a Database Instance configuration that allows you to create a standby node, with an up-to-date replica of the database. If the main node fails for any reason, the standby can take over requests, reducing downtime.
@@ -99,6 +105,9 @@ Compared to traditional database management, which requires customers to provisi
99105

100106
A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. The replica mirrors the data of the primary Database node and any changes made are synchronized and reflected in the replica.
101107

108+
Refer to the [How to manage Read Replicas](/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replicas/) documentation page for more information.
109+
110+
102111
## Region and Availability Zone
103112

104113
<RegionAndAz />

pages/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replicas.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Requirements from '@macros/iam/requirements.mdx'
1010

1111
A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. The replica mirrors the data of the primary Database node and any changes made are replicated to the replica asynchronously.
1212

13-
Read Replicas allow you to scale your Database Instance for read-heavy database workloads. They can also be used for business intelligence workloads.
13+
[Read Replicas](/managed-databases-for-postgresql-and-mysql/concepts/#read-replica) allow you to scale your Database Instance for read-heavy database workloads. They can also be used for business intelligence workloads.
1414

1515
<Requirements />
1616

pages/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ dates:
99
import Requirements from '@macros/iam/requirements.mdx'
1010
import Autobackups from '@macros/databases/autobackups.mdx'
1111

12-
[Snapshots](/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots/) allow you to restore data in a new Database Instance, instead of creating individual automated database backups. It is only available for Database Instances that use Block Storage volumes.
12+
[Snapshots](/managed-databases-for-postgresql-and-mysql/concepts/#database-snapshot) allow you to restore data in a new Database Instance, instead of creating individual automated database backups. It is only available for Database Instances that use Block Storage volumes.
1313

1414
When you set up [autobackups](/managed-databases-for-postgresql-and-mysql/how-to/manage-backups/) for Database Instances that use Block Storage, the automatic backups are created in snapshot format.
1515

pages/managed-databases-for-postgresql-and-mysql/reference-content/encryption-at-rest-performance-benchmark.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ dates:
77
posted: 2024-12-19
88
---
99

10-
In December 2024, the Scaleway Managed Databases team ran tests on DB-POP2-4C-16G Instances in a Private Network using `pgbench`. Several workloads (including read, oltp and large loads) were simulated with several scale factors (from 1M rows to 200M rows) and concurrent database connections set to 10. They measured the impact of encryption at rest on transactions, per second and latency.
10+
In December 2024, the Scaleway Managed Databases team ran tests on DB-POP2-4C-16G Instances in a Private Network using `pgbench`. Several workloads (including read, oltp and large loads) were simulated with several scale factors (from 1M rows to 200M rows) and concurrent database connections set to 10. They measured the impact of [encryption at rest](/managed-databases-for-postgresql-and-mysql/concepts/#encryption-at-rest) on transactions, per second and latency.
1111

1212
<Message type="important">
1313
For more information on pgbench transactions, refer to the "What is the 'Transaction' actually performed in pgbench?" section of the official [pgbench documentation](https://www.postgresql.org/docs/current/pgbench.html).

pages/managed-databases-for-redis/concepts.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ A Redis™<sup>*</sup> cluster consists of a set of primary and secondary nodes.
2020

2121
Each Managed Database for Redis™ cluster consists of minimum three and maximum six compute Instances hosting each a primary Redis™ Instance and a secondary Instance for one of the other nodes. If one of the primary nodes fails, the remaining nodes hold a vote and elect one of the remaining secondary nodes as the new primary node. When the failing node rejoins the cluster, it automatically becomes a secondary node and begins to replicate the data of another primary node.
2222

23+
Learn more about the cluster mode on the [Managed Databases for Redis™ FAQ page](/managed-databases-for-redis/faq/#what-is-the-logic-behind-the-cluster-mode).
24+
2325
## Endpoint
2426

2527
An endpoint is a point of connection to a database. The endpoint is associated with one or more public IPv4 addresses and a port, or with a private IPv4 and a port (if you use [Private Networks](/vpc/concepts/#private-networks)).

pages/organizations-and-projects/concepts.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The Organization ID identifies the [Organization](#organization) created with yo
2828

2929
A Project is a grouping of Scaleway [resources](#resource). Each Scaleway Organization comes with a default Project, and you can create new Projects if necessary. Projects are cross-region, meaning resources located in different [regions](/instances/concepts/#region) can be grouped in one single Project. When grouping resources into different Projects, you can use [IAM](/iam/concepts/#iam) to define custom access rights for each Project.
3030

31+
Refer to the [How to create a Project](/organizations-and-projects/how-to/create-a-project) documentation page for more information.
32+
3133
## Project dashboard
3234

3335
The Project dashboard can be viewed within the [console](https://console.scaleway.com/project). On this dashboard, you can see an overview of the Project's [resources](#resource), along with the Project's settings and credentials ([SSH keys](#ssh-key)).
@@ -45,6 +47,11 @@ An SSH key (**S**ecure **Sh**ell key) allows passwordless connection to an [Inst
4547

4648
The public key is kept in your Scaleway account and transferred to the Instance during the boot process, while the identification key is kept securely on your local computer. When connecting to the Instance via SSH, a trusted connection to the machine is established using the key pair.
4749

50+
Refer to the [How to create an SSH key](/organizations-and-projects/how-to/create-ssh-key) documentation page for more information.
51+
52+
4853
## Quotas
4954

50-
Every [Organization](/organizations-and-projects/concepts/#organization) has quotas, which are limits on the number of Scaleway resources they can use. Quotas are per product (e.g. Instances) and product type (e.g. GP1-L Instance). Quotas are designed to prevent abuse, and can be viewed on the [Organization dashboard](https://console.scaleway.com/organization/quotas) of the console and in the [Understanding quotas](/organizations-and-projects/additional-content/organization-quotas) documentation page.
55+
Every [Organization](/organizations-and-projects/concepts/#organization) has quotas, which are limits on the number of Scaleway resources they can use. Quotas are per product (e.g. Instances) and product type (e.g. GP1-L Instance). Quotas are designed to prevent abuse, and can be viewed on the [Organization dashboard](https://console.scaleway.com/organization/quotas) of the console.
56+
57+
Refer to the [Understanding quotas](/organizations-and-projects/additional-content/organization-quotas) reference page for a list of the available quotas.

0 commit comments

Comments
 (0)