Skip to content
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

update: Rename Redis to Aiven for Caching #171

Merged
merged 46 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
62a5369
update: Rename Redis to Aiven for Caching
harshini-rangaswamy Apr 24, 2024
636f437
updated: rename Redis to Caching
harshini-rangaswamy May 6, 2024
f27007d
update: actions steps
harshini-rangaswamy May 6, 2024
4d7609d
update: actions steps
harshini-rangaswamy May 6, 2024
2a26e9f
update: more topics updated
harshini-rangaswamy May 6, 2024
47c3130
update: Redis to caching more content updated
harshini-rangaswamy May 7, 2024
dca2bc7
update: Redis to caching more content updated
harshini-rangaswamy May 7, 2024
3ba5e7c
update: fix links
harshini-rangaswamy May 14, 2024
1d93ce9
Remove outdated yarn.lock
harshini-rangaswamy May 14, 2024
6858ae4
update: more content updates
harshini-rangaswamy May 14, 2024
c32c013
update: added redirects for Redis
harshini-rangaswamy May 15, 2024
b13b55c
Merge branch 'main' into harshini-rename-redis
harshini-rangaswamy May 15, 2024
fa571f9
Update index.tsx
harshini-rangaswamy May 15, 2024
0cf58dc
updated: addressed feedback
harshini-rangaswamy May 16, 2024
c85886b
Merge branch 'main' into harshini-rename-redis
harshini-rangaswamy May 16, 2024
2c164f6
fix: remove extra comment in supported ClickHouse IO formats (#196)
aris-aiven May 17, 2024
2833085
update: orgs and units overview for clarity (#188)
staceysalamon-aiven May 21, 2024
4c0112e
update: add team as owner
ArthurFlag May 22, 2024
1a7636c
update: linking profiles to IdPs (#209)
staceysalamon-aiven May 22, 2024
3da1bfb
update(clickhouse): add clouds supporting tiered storage (#198)
wojcik-dorota May 22, 2024
fe0ea4b
update: kpow documentation to use latest screenshots and links (#207)
prabhjots May 22, 2024
d21debd
(dragonfly) Update advanced parameters (#201)
github-actions[bot] May 22, 2024
2cd2daf
Update: rename in backup topic
harshini-rangaswamy May 23, 2024
8343e78
update: Flink ref doc link version to 1.16 (#92)
harshini-rangaswamy May 23, 2024
451845e
fix(integrations): bigquery integration supported for Flink only (#214)
wojcik-dorota May 23, 2024
e60abef
update: more files updated
harshini-rangaswamy May 23, 2024
97cb890
update: first usage conditions
harshini-rangaswamy May 23, 2024
83a4608
update: Rename Redis to Aiven for Caching
harshini-rangaswamy Apr 24, 2024
be082da
updated: rename Redis to Caching
harshini-rangaswamy May 6, 2024
889b912
update: actions steps
harshini-rangaswamy May 6, 2024
1263ff5
update: actions steps
harshini-rangaswamy May 6, 2024
d2ef8a0
update: more topics updated
harshini-rangaswamy May 6, 2024
427a35d
update: Redis to caching more content updated
harshini-rangaswamy May 7, 2024
367017e
update: Redis to caching more content updated
harshini-rangaswamy May 7, 2024
0b6b50e
update: fix links
harshini-rangaswamy May 14, 2024
b720b38
Remove outdated yarn.lock
harshini-rangaswamy May 14, 2024
40aeef2
update: more content updates
harshini-rangaswamy May 14, 2024
fdc4208
update: added redirects for Redis
harshini-rangaswamy May 15, 2024
6289e02
Update index.tsx
harshini-rangaswamy May 15, 2024
e184f82
updated: addressed feedback
harshini-rangaswamy May 16, 2024
73212d4
Update: rename in backup topic
harshini-rangaswamy May 23, 2024
792a5fc
update: more files updated
harshini-rangaswamy May 23, 2024
adb6ddf
update: first usage conditions
harshini-rangaswamy May 23, 2024
79609a1
update: resolved conflicts
harshini-rangaswamy May 23, 2024
991958a
update: resolved conflicts
harshini-rangaswamy May 23, 2024
693f128
update: trademark
harshini-rangaswamy May 23, 2024
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
3 changes: 2 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
* @ArthurFlag
# * @ArthurFlag
* @aiven/aiven-technical-writers
static/includes
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ level: error
scope: text
ignorecase: false

first: '\b(Redis)(?!®\*)'
second: '(Redis)(?:®\*)'
first: '\b(Caching)(?!®)'
second: '(Caching)(?:®)'
1 change: 1 addition & 0 deletions .github/vale/styles/config/vocabularies/Aiven/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Grafana
Grafana/M
GSuite
hardcoded
HAProxy
HashiCorp
Heatmap
Hillyer
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
.env.test.local
.env.production.local

# JetBrains IDEs
.idea

# Yarn
!.yarn/patches
!.yarn/plugins
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"markdown.extension.orderedList.marker": "one",
"files.associations": {
"config": "properties",
"_redirects": "ini"
"_redirects": "ini",
"CODEOWNERS": "ini"
},
"[properties]": {
"editor.formatOnSave": false
Expand Down
150 changes: 0 additions & 150 deletions docs/integrations/google-bigquery.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/platform/concepts/corporate-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ based on the services running in a project. Each project is charged
separately, but the charges for multiple projects can be consolidated by
assigning them to a
[billing group](/docs/platform/concepts/billing-groups). Likewise,
[organizations](/docs/platform/concepts/projects_accounts_access) can have multiple billing groups.
[organizations](/docs/platform/concepts/orgs-units-projects) can have multiple billing groups.

## Credit card fees

Expand All @@ -36,7 +36,7 @@ different. The fee may be applied even if the card was charged in the
card's default currency (USD).

Such fees are not added by Aiven and are not visible to us or our credit
card processor, and we're thus unable to include them in our prices or
card processor, so we're unable to include them in our prices or
waive the fees.

## Invoice payments
Expand Down
8 changes: 4 additions & 4 deletions docs/platform/concepts/free-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Free plans
---

The free plan is available for Aiven for PostgreSQL®, Aiven for MySQL,
and Aiven for Redis®\* services. You don't need a credit card to sign
and Aiven for Caching® services. You don't need a credit card to sign
up and you can create one free service for each type. This means you can
create one free PostgreSQL, one free MySQL, and one free Redis service.
create one free PostgreSQL, one free MySQL, and one free Caching® service.

To try a different service, you may want to consider a
30-day
Expand All @@ -27,7 +27,7 @@ Free plans include:
- 1 CPU per virtual machine
- 1 GB RAM
- For PostgreSQL and MySQL: 5 GB disk storage
- For Redis: `maxmemory` set to 50%
- For Caching: `maxmemory` set to 50%
- Management via our web console, CLI, API, Terraform provider, or
Kubernetes® operator
- Monitoring for metrics and logs
Expand All @@ -48,7 +48,7 @@ There are some limitations of the free plan services:
- Only a limited number of DigitalOcean regions, no other cloud
providers
- Only one service per service type per user and
[organization](/docs/platform/concepts/projects_accounts_access)
[organization](/docs/platform/concepts/orgs-units-projects)
- Not covered under Aiven's 99.99% SLA

Free plans do not have any time limitations. However, Aiven reserves the
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/maintenance-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Aiven service upgrades are performed in rolling forward style, which
means that new service nodes are first created alongside with the older
nodes one at a time, after which the old nodes are retired.

For **MySQL®**, **PostgreSQL®** and **Redis®**\*, the maintenance
For **MySQL®**, **PostgreSQL®** and **Caching®**, the maintenance
window usually lasts around several seconds. The downtime comes from old
master stopping itself in a controlled manner and new master executing
promotion sequence after this. Once the promotion is complete the old
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/orgs-and-units.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Organizations and units
---

You automatically have an organization when you sign up for Aiven and helps you [centrally manage billing and access](/docs/platform/concepts/projects_accounts_access#organizations-and-organizational-units). Add organizational units in your organization to group related projects together.
You automatically have an organization when you sign up for Aiven where you [centrally manage billing and access](/docs/platform/concepts/orgs-units-projects). You can add organizational units in your organization to group related projects together.
121 changes: 121 additions & 0 deletions docs/platform/concepts/orgs-units-projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: Organizations, units, and projects
---

The Aiven platform uses organizations, organizational units, and projects to efficiently and securely organize your services and manage access.

import Overview from "@site/static/images/content/figma/organizations-overview.png";

<img alt="Hierarchy showing two organizational units, each with two projects, nested within one organization." src={Overview} width="58%" class="centered"/>

There are three levels in this hierarchy:

1. Organization: Contains all of your projects and services. It's recommended to have one
Aiven organization.
1. Organizational units: Added to the organization, giving you greater flexibility to
organize your infrastructure based on your specific use cases. For example, you can
split production and testing workloads into different organizational units.
1. Projects: Created in the organization or organizational units to group your services
together.

## Organizations

When you sign up to Aiven, an organization is created for you. You can use your
organization to create a hierarchical structure that fits your needs.

Organizations also let you centrally manage settings like:

- [Domains and identity providers](/docs/platform/howto/list-identity-providers):
Only available at the organization level
- [Authentication policies](/docs/platform/howto/set-authentication-policies):
Only available on the organization level
- Access control lists (ACLs): Can be set on all levels (organization,
organizational unit, and project)
- ACLs for service plans are inherited, meaning all projects
within an organization or organizational unit have the same service plan.
- [Groups](/docs/platform/howto/list-groups): Managed only at the organization level
and assigned to projects
- [Support tiers](/docs/platform/howto/support): Specific to a single organization and
apply to all units, projects, and services within that organization. They cannot be
shared between organizations.
- [Billing information](/docs/platform/concepts/hourly-billing-model): Managed at the
organization level. They can be used for all projects in the organization
and its units. They cannot cannot be shared between organizations.

## Organizational units

Organizational units are collections of projects. Customers often use these to group
projects based on things like:
- Departments in their company like finance, marketing, and engineering
- Environments such as development, testing, and production

You can create as many units as you need in your organization, but you cannot
create units in other units.

## Projects

Projects are collections of services and user permissions. You can
[create projects](/docs/platform/howto/manage-project) in an organization
or in organizational units.

Projects help you group your services based on your organization's structure or processes.
They also let you apply uniform network security settings across all services within
the project. The following are some examples of how customers organize their services:

- Single project: One project containing services that are
distinguished by their names. For example, services have names based
on the type of environment: `demo_pg_project.postgres-prod` and
`demo_pg_project.postgres-staging`.
- Environment-based: Each project represents a deployment environment,
for example: `dev`, `qa`, and `production`. This can make it easier to apply
uniform user permissions, such as developer access to production infrastructure.
- Project-based: Each project contains all the services for an
internal project, with naming that highlights the relevant
environment. For example: `customer-success-prod` and `business-analytics-test`.

## Users and roles

To add users to your organization, you send them an invite. Organization users can be
made super admin or they can be added to specific projects. They can also be [added to
groups](/docs/platform/howto/manage-groups) to control access to the services in a project.

Super admin have full access to the organization, including all organizational units,
projects, and services. Users are automatically made super admin when they create an
organization, and they can [make other users super admin](/docs/platform/howto/make-super-admin).

You grant other users access to services at the project level by
[adding them as project members](/docs/platform/howto/add-project-members),
either individually or in groups. You give project members a role that defines the
level of access they have to all services in the project.

The Aiven platform lets you use a mix of group and individual access
rights for projects.

## Best practices for organizations

### Small organizations

For smaller organizations that have a limited number of projects it's
recommended to consolidate all your projects within one organization.
This makes it easier for your teams to navigate between projects and
services.

Good naming conventions also help with finding projects and services.
For example, you can include the environment type, `dev`, `prod`,
etc., at the beginning of project names.

### Medium organizations

For more complex cases, take advantage of the
organizational units. Organizational units group related projects.

You can, for example, group projects into organizational units that
correspond to your internal departments. Alternatively, you can group
them by categories like testing, staging, and production environments.

### Large organizations

For large organizations, keep your projects in
organizational units instead of organizations. By keeping your
projects in organizational units you can centrally manage things like
support contracts and billing groups for each group of projects.
Loading