Skip to content

Commit

Permalink
Merge branch 'main' into staceys-doc-1200
Browse files Browse the repository at this point in the history
Signed-off-by: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com>
  • Loading branch information
staceysalamon-aiven authored Dec 9, 2024
2 parents 4d09b56 + 4181dd7 commit 36f7dcf
Show file tree
Hide file tree
Showing 98 changed files with 2,106 additions and 868 deletions.
3 changes: 3 additions & 0 deletions .github/vale/styles/Aiven/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ exceptions:
- Active Directory
- Aiven
- Aiven Console
- Aiven Kubernetes Operator
- Aiven Operator for Kubernetes
- Aiven Provider
- Aiven Provider for Terraform
- Aiven Terraform Provider
- Amazon
- Amazon Aurora
- Amazon Web Services
Expand Down
23 changes: 9 additions & 14 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
Aiven provides managed open source services for streaming, storing and analyzing data on all major clouds.
All services run reliably and securely in the clouds of your choice, are observable, and can easily be integrated with each other and with external 3rd party tools.

<img src={Overview} className="centered" alt="" width="54%" />
<img src={Overview} className="centered" alt="Illustration of the platform" width="54%" />

## Discover the Aiven platform

Expand Down Expand Up @@ -170,16 +170,11 @@ Add users to groups to streamline access management to your Aiven projects and s
description="Create and add users to groups."
/>
<Card
to="/docs/platform/concepts/permissions"
iconName="book"
title="Project member roles"
description="View project permissions you can assign to users and groups."
/>
<Card
to="/docs/platform/howto/add-groups-projects"
to="/docs/platform/howto/manage-permissions"
iconName="clipboardCheck"
title="Add groups to projects"
description="Give a group of users access to a project."
title="Give groups acess to projects"
description="Grant roles and permissions to a group of users to access a project
and its services."
/>
</GridContainer>

Expand Down Expand Up @@ -227,8 +222,8 @@ Add users to groups to streamline access management to your Aiven projects and s
to="/docs/platform/howto/manage-application-users"
iconName="clipboard"
title="Create application users"
description="Use application users to access the API,
Terraform Provider, CLI, and Aiven Operator."
description="Use application users to access the Aiven API,
Terraform Provider, CLI, and Kubernetes Operator."
/>
<Card
to="/docs/platform/howto/manage-vpc-peering"
Expand Down Expand Up @@ -270,7 +265,7 @@ Start deploying services in your project to stream, store, or analyze your data.

See examples of services and integrations using code samples for the
[Aiven Provider for Terraform](/docs/tools/terraform) or
[Aiven Operator for Kubernetes](/docs/tools/kubernetes).
[Aiven Operator for Kubernetes®](/docs/tools/kubernetes).

<GridContainer columns={2}>
<Card
Expand All @@ -281,7 +276,7 @@ See examples of services and integrations using code samples for the
<Card
to="https://aiven.github.io/aiven-operator/resources/project.html"
iconComponent={K8sIcon}
title="Aiven Operator for Kubernetes examples"
title="Aiven Operator for Kubernetes® examples"
/>
</GridContainer>

Expand Down
14 changes: 7 additions & 7 deletions docs/platform/concepts/application-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Application users

import ConsoleLabel from "@site/src/components/ConsoleIcons"

An application user is a type of user that provides programmatic access to the Aiven platform and services through the [Aiven API](/docs/tools/api.md), [CLI](/docs/tools/), [Terraform](/docs/tools/terraform.md), and [Kubernetes](/docs/tools/kubernetes.md). They're intended for non-human users that need to access Aiven.
An application user is a type of user that provides programmatic access to the Aiven platform and services through the [Aiven API](/docs/tools/api.md), [CLI](/docs/tools/), [Aiven Terraform Provider](/docs/tools/terraform.md), and [Aiven Kubernetes Operator](/docs/tools/kubernetes). They're intended for non-human users that need to access Aiven.

:::info
You must be a [super admin](/docs/platform/howto/make-super-admin) to access this feature.
Expand All @@ -13,11 +13,11 @@ You must be a [super admin](/docs/platform/howto/make-super-admin) to access thi
## Application user permissions

You [create and manage application users](/docs/platform/howto/manage-application-users)
at the organization level. Application users are granted access to projects
and services in the same way as organization users by adding them to
[projects](/docs/platform/howto/add-project-members) and assigning them a role. You can
also make application users super admin, giving them full access to your organization,
its organizational units, projects, services, and billing and other settings.
at the organization level and you
[give them access to projects and services](/docs/platform/howto/manage-permissions)
in the same way as organization users. You can also make application users super admin,
giving them full access to your organization, its organizational units, projects,
services, and billing and other settings.

Unlike organization users, application users can't log in to the Aiven Console and the
authentication policies don't apply to them.
Expand All @@ -32,7 +32,7 @@ following are some suggested best practices for using Aiven application users.

Try to create a different application user for each tool or application. For example, if
you have an application that needs to connect to services in one of your projects and
you are using Terraform in the same project, create two application users. Use
you're using Aiven Terraform Provider in the same project, create two application users. Use
the description field for each user to clearly indicate what it's used for.

This helps you manage the lifecycle of the users and ensure the access permissions are
Expand Down
3 changes: 1 addition & 2 deletions docs/platform/concepts/byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ needs or project requirements, such as:
The BYOC setup is a bespoke service offered on a case-by-case basis, and
not all cloud providers support it yet. You're eligible for BYOC if:

- You use Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure
(excluding Azure Germany), or Oracle Cloud Infrastructure (OCI).
- You use Amazon Web Services (AWS) or Google Cloud.
- You have a commitment deal with Aiven.
- You have the [Advanced or Premium support tier](/docs/platform/howto/support).

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/enhanced-compliance-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ accordingly.
## Similarities to a standard environment

In many ways, an ECE is the same as a standard Aiven deployment.
Aiven's tooling, such as [CLI](/docs/tools/cli) and [Terraform](/docs/tools/terraform),
Aiven's tooling, such as [Aiven CLI](/docs/tools/cli) and [Aiven Terraform Provider](/docs/tools/terraform),
interact with ECEs seamlessly, you will still be able to take advantage of Aiven's
service integrations, and you can access the environment
through VPC peering or Privatelink (on AWS or Azure).
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/concepts/free-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Free plans include:
- 1 GB RAM
- For PostgreSQL and MySQL: 5 GB disk storage
- For Valkey: `maxmemory` set to 50%
- Management via our web console, CLI, API, Terraform provider, or
Kubernetes® operator
- Management through the Aiven Console, CLI, API, Terraform Provider, or
Kubernetes Operator
- Monitoring for metrics and logs
- Backups
- Integrations between different Aiven services including free, paid,
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/free-trial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 30-day trials
---

Aiven offers a free trial for 30 days to explore the platform - including the [Aiven Console](/docs/tools/aiven-console), [API](/docs/tools/api), [CLI](/docs/tools/cli), [Aiven Terraform provider](/docs/tools/terraform), and [Aiven Operator for Kubernetes](/docs/tools/kubernetes) - and the [Aiven services](/docs/products/services). You don't need a credit card to sign up.
Aiven offers a free trial for 30 days to explore the Aiven Data and AI Platform, including the [Aiven Console](/docs/tools/aiven-console), [API](/docs/tools/api), [CLI](/docs/tools/cli), [Aiven Provider for Terraform](/docs/tools/terraform), [Aiven Operator for Kubernetes®](/docs/tools/kubernetes), and the [Aiven services](/docs/products/services). You don't need a credit card to sign up.

## Trial features and limitations

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/orgs-units-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Organizations also let you centrally manage settings like:
the organization level, you can use billing groups across all projects in the
organization and its units. You can't share billing information between organizations.
- [Users](/docs/platform/concepts/user-access-management) and
[groups](/docs/platform/howto/list-groups): Managed at the organization level. You
[groups](/docs/platform/howto/manage-groups): Managed at the organization level. You
can grant users and groups access at the organization and project level with
[permissions and roles](/docs/platform/concepts/permissions).
- [Domains](/docs/platform/howto/manage-domains) and
Expand Down
31 changes: 30 additions & 1 deletion docs/platform/concepts/service-forking.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ You can only fork services that have at least one [backup](/docs/platform/concep
Apply any integrations required by the fork.

</TabItem>
<TabItem value="API" label="API">
<TabItem value="CLI" label="CLI">

1. Prepare the command to create service, this will contain the
new copy of your data store.
Expand All @@ -95,6 +95,35 @@ avn service create forked --project PROJECT_NAME --cloud CLOUD_NAME -t pg --plan

Apply any integrations required by the fork.

</TabItem>
<TabItem value="API" label="API">

Use the [`ServiceCreate` endpoint](https://api.aiven.io/doc/#tag/Service/operation/ServiceCreate)
and set the `service_to_fork_from` and `project_to_fork_from` parameters to specify the
source service in the `user_config` property.

For example:

```bash {11,12}
curl --location 'https://console.aiven.io/v1/project/dest-project/service' \
--header 'Content-Type: application/json' \
--header 'Authorization: token' \
--data '{
"cloud":"google-europe-central2",
"group_name":"default",
"plan":"business-4",
"service_name":"dest-name",
"service_type":"pg",
"user_config":{
"service_to_fork_from":"source-service",
"project_to_fork_from":"source-project",
"pg_version":"16"
}
}'
```

Apply any integrations required by the fork.

</TabItem>
</Tabs>

Expand Down
5 changes: 3 additions & 2 deletions docs/platform/concepts/service_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,9 @@ data persistence using Redis Database Backup (RDB).

#### Persistence settings

You can configure the `redis_persistence` settings from the **Advanced configuration**
section on your <ConsoleLabel name="service settings"/> page in the [Aiven Console](https://console.aiven.io).
You can configure the `redis_persistence` settings from <ConsoleLabel name="actions"/> >
the **Configure backup settings** section on your <ConsoleLabel name="Backups"/> page
in the [Aiven Console](https://console.aiven.io).

- **Enabled (`rdb`)**: When you set `redis_persistence` to `rdb`, Aiven for Caching
performs RDB dumps every 10 minutes whenever a key changes. These dumps provide
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/tax-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ According to the tax treaty between Finland and the United States,
no direct tax needs to be withheld from payments by American entities to
Aiven. Although a W-8 form is not required to confirm this status,
we're happy to provide a W-8BEN-E form describing Aiven's status.
Contact the [sales team](mailto:sales@aiven.io) to request one.
Contact [billing@aiven.io](mailto:billing@aiven.io) to request one.

Aiven charges American sales taxes in several states in the United-States. The
applicability of these taxes depends on various factors, such as the
Expand Down
23 changes: 0 additions & 23 deletions docs/platform/howto/add-groups-projects.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/platform/howto/add-project-members.md

This file was deleted.

30 changes: 2 additions & 28 deletions docs/platform/howto/byoc/create-custom-cloud.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create a custom cloud
sidebar_label: Create custom clouds
keywords: [AWS, Amazon Web Services, Microsoft Azure, GCP, Google Cloud Platform, byoc, bring your own cloud, custom cloud, OCI, Oracle Cloud Infrastructure]
keywords: [AWS, Amazon Web Services, GCP, Google Cloud Platform, byoc, bring your own cloud, custom cloud]
---

import ConsoleLabel from "@site/src/components/ConsoleIcons";
Expand Down Expand Up @@ -63,15 +63,6 @@ Next, you deploy your custom cloud resources supplying the generated privilege-b
as a parameter. Finally, you select in which Aiven projects to use your custom cloud, and
you assign a contact person for your custom cloud.
</TabItem>
<TabItem value="3" label="Azure & OCI">
If you use Azure or OCI as a cloud provider, you'll have your
custom cloud created by the Aiven team. Just
[enable the BYOC feature](/docs/platform/howto/byoc/enable-byoc) and specify your
requirements. The Aiven team will build your custom cloud according to the specification
you provide. There are no further actions required from you to create your custom cloud.
The Aiven team might reach out to you for more details and will follow up with you to keep
you informed on the progress.
</TabItem>
</Tabs>

## Limitations {#byoc-limitations}
Expand All @@ -85,11 +76,6 @@ you informed on the progress.
Contact your account team to learn more or upgrade your support tier.
:::

- You can create custom clouds yourself (via the BYOC self-service) if your cloud
provider is AWS (in the [Aiven Console](https://console.aiven.io/)) or GCP (via [Aiven
CLI client](/docs/tools/cli/byoc)).
For Azure & OCI, [request creating a custom cloud](/docs/platform/howto/byoc/enable-byoc)
from the Aiven team.
- Only [super admins](/docs/platform/howto/make-super-admin) can create custom clouds.

## Prerequisites {#byoc-prerequisites}
Expand All @@ -100,7 +86,7 @@ you informed on the progress.
- You have an active account with your cloud provider.
- Depending on the dev tool to use for creating a custom cloud, you have:
- Access to the [Aiven Console](https://console.aiven.io/) or
- [Aiven CLI client](/docs/tools/cli) installed
- [Aiven CLI](/docs/tools/cli) installed
- You have the [super admin](/docs/platform/howto/make-super-admin) role in your Aiven
organization.
- You have Terraform installed.
Expand All @@ -120,10 +106,6 @@ you informed on the progress.
- [Aiven Console](https://console.aiven.io/) > <ConsoleLabel name="userinformation"/>
\> <ConsoleLabel name="organizations"/>.

</TabItem>
<TabItem value="3" label="Azure & OCI">
You have access to the [Aiven Console](https://console.aiven.io/) to
[enable the BYOC feature](/docs/platform/howto/byoc/enable-byoc).
</TabItem>
</Tabs>

Expand Down Expand Up @@ -508,9 +490,6 @@ For more information on Google Cloud roles, see
[IAM basic and predefined roles reference](https://cloud.google.com/iam/docs/understanding-roles)
in the Goodle Cloud documentation.
</TabItem>
<TabItem value="3" label="Azure & OCI permissions">
The Aiven team will talk to you to determine required permissions.
</TabItem>
</Tabs>

## Create a custom cloud {#create-cloud}
Expand Down Expand Up @@ -931,11 +910,6 @@ Your new custom cloud is ready to use only after its status changes to
extract from the output of the [avn byoc list](/docs/tools/cli/byoc#avn-byoc-list)
command, for example `018b6442-c602-42bc-b63d-438026133f60`.

</TabItem>
<TabItem value="3" label="Azure & OCI">
To integrate with the Azure or OCI cloud providers, you'll have your custom cloud created
by the Aiven team. [Enable the BYOC feature](/docs/platform/howto/byoc/enable-byoc) and
follow up with the Aiven team from there.
</TabItem>
</Tabs>

Expand Down
7 changes: 2 additions & 5 deletions docs/platform/howto/byoc/enable-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,8 @@ You must be a [super admin](/docs/platform/howto/make-super-admin) to enable thi

## Next steps

With BYOC activated in your Aiven organization, you can create and use custom
clouds:

- [By yourself if using AWS or GCP](/docs/platform/howto/byoc/create-custom-cloud#create-cloud).
- By contacting the Aiven team if using Azure or OCI.
With BYOC activated in your Aiven organization, you can
[create and use custom clouds](/docs/platform/howto/byoc/create-custom-cloud).

## Related pages

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/disk-autoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ listed on [Aiven Plans and Pricing](https://aiven.io/pricing?product=kafka).
- Disk autoscaling works on fully running services only and cannot happen during
maintenance updates.
- If you change disk space manually, you might delay an autoscaling process.
- When using Aiven Autoscaler, don't try to control your disk space with Terraform
so that you avoid potential conflicts between those two tools.
- When using Aiven Autoscaler, don't try to control your disk space with the Aiven
Terraform Provider to avoid potential conflicts between those two tools.
- Disk added for extra storage is slower than the original disk until service maintenance
is applied. This may have performance implications depending on the load on your service.
Dynamically adding disk (either manually or in an automated fashion) may not be
Expand Down
15 changes: 15 additions & 0 deletions docs/platform/howto/download-invoices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Download invoices
---

import ConsoleLabel from "@site/src/components/ConsoleIcons"

You can download monthly invoices from the Aiven Console in PDF or CSV format.

:::info
You must be a [super admin](/docs/platform/howto/make-super-admin) to access this feature.
:::

1. Click **Billing**.
1. Click **Invoices**.
1. Click <ConsoleLabel name="Actions"/> > **Download PDF** or **Download CSV**.
6 changes: 0 additions & 6 deletions docs/platform/howto/list-groups.md

This file was deleted.

Loading

0 comments on commit 36f7dcf

Please sign in to comment.