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

Rbac #140

Merged
merged 323 commits into from
Oct 1, 2024
Merged

Rbac #140

Show file tree
Hide file tree
Changes from 233 commits
Commits
Show all changes
323 commits
Select commit Hold shift + click to select a range
58d0ef1
Update rbac.md
rasika-chivate Jul 15, 2024
4361a8f
Update rbac.md
rasika-chivate Jul 15, 2024
3b435f8
Update rbac.md
rasika-chivate Jul 15, 2024
c51d55d
Update rbac.md
rasika-chivate Jul 15, 2024
cafab59
Update rbac.md
rasika-chivate Jul 15, 2024
21f051c
Update rbac.md
rasika-chivate Jul 15, 2024
9dd287c
Update rbac.md
rasika-chivate Jul 15, 2024
0536ebf
Update rbac.md
rasika-chivate Jul 15, 2024
aa38b8b
Update rbac.md
rasika-chivate Jul 15, 2024
f0146d2
Update rbac.md
rasika-chivate Jul 15, 2024
9a4ab91
Update rbac.md
rasika-chivate Jul 15, 2024
deba07e
Update rbac.md
rasika-chivate Jul 15, 2024
b2a5567
Update rbac.md
rasika-chivate Jul 15, 2024
879d727
Update rbac.md
rasika-chivate Jul 15, 2024
b0071d8
Update rbac.md
rasika-chivate Jul 15, 2024
15cd370
Update rbac.md
rasika-chivate Jul 15, 2024
ec44530
Update rbac.md
rasika-chivate Jul 16, 2024
4431057
assign permission to new user
rasika-chivate Jul 16, 2024
a74dc12
Update rbac.md
rasika-chivate Jul 16, 2024
7591ec5
Update rbac.md
rasika-chivate Jul 16, 2024
8910e5b
Update rbac.md
rasika-chivate Jul 16, 2024
fde657e
Update rbac.md
rasika-chivate Jul 16, 2024
5813fa3
Update rbac.md
rasika-chivate Jul 16, 2024
12212d6
add link
rasika-chivate Jul 16, 2024
ca45027
Update rbac.md
rasika-chivate Jul 16, 2024
73f9a79
Update rbac.md
rasika-chivate Jul 16, 2024
372c48a
Update mkdocs-base.yml
rasika-chivate Jul 16, 2024
adf4b97
Update rbac.md
rasika-chivate Jul 16, 2024
c100541
Update rbac.md
rasika-chivate Jul 16, 2024
a1ab4d0
Update manage_users.md
rasika-chivate Jul 16, 2024
4f46a46
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
2701f9c
Update rbac.md
rasika-chivate Jul 16, 2024
7527521
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Jul 16, 2024
857770c
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
3ba0d8b
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
1f916c9
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
7875987
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
578dfd9
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
3f87a75
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
9872006
change the read only policy
rasika-chivate Jul 16, 2024
0968c1c
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
3aeb1da
Update rbac.md
rasika-chivate Jul 16, 2024
35e829a
Update docs/administer/rbac.md
rasika-chivate Jul 16, 2024
779829b
Update rbac.md
rasika-chivate Jul 17, 2024
e13bea4
Update rbac.md
rasika-chivate Jul 17, 2024
e10dfa4
Update rbac.md
rasika-chivate Jul 17, 2024
62b88ff
Update rbac.md
rasika-chivate Jul 17, 2024
ae799f2
Update rbac.md
rasika-chivate Jul 18, 2024
4656956
Update rbac.md
rasika-chivate Jul 18, 2024
6b10430
Update rbac.md
rasika-chivate Jul 18, 2024
dc4ebd8
Update rbac.md
rasika-chivate Jul 18, 2024
fd58a86
Update rbac.md
rasika-chivate Jul 18, 2024
3c81564
Update rbac.md
rasika-chivate Jul 18, 2024
e68d84b
Update rbac.md
rasika-chivate Jul 19, 2024
f536d52
Update rbac.md
rasika-chivate Jul 19, 2024
d492f26
Update rbac.md
rasika-chivate Jul 19, 2024
30dbdf8
Update rbac.md
rasika-chivate Jul 19, 2024
317c8fc
Update rbac.md
rasika-chivate Jul 19, 2024
1a3af98
Update rbac.md
rasika-chivate Jul 19, 2024
4f44b77
Update rbac.md
rasika-chivate Jul 19, 2024
c420ab5
Update rbac.md
rasika-chivate Jul 21, 2024
b366b05
test RBAC policcy
rasika-chivate Jul 21, 2024
0e843c2
Update rbac.md
rasika-chivate Jul 21, 2024
7930d2e
Update rbac.md
rasika-chivate Jul 21, 2024
085a08e
Update rbac.md
rasika-chivate Jul 21, 2024
7ecf507
Update docs/administer/rbac.md
rasika-chivate Jul 21, 2024
2c7c601
Update docs/administer/rbac.md
rasika-chivate Jul 21, 2024
9ced5ff
Update rbac.md
rasika-chivate Jul 21, 2024
6fa007e
Update rbac.md
rasika-chivate Jul 21, 2024
8626513
Merge branch 'main' into RBAC
rasika-chivate Aug 26, 2024
18f5229
added api changes topic
rasika-chivate Aug 26, 2024
58553b5
Update api_rbac.md
rasika-chivate Aug 27, 2024
6b6c354
Update api_rbac.md
rasika-chivate Aug 27, 2024
82cab08
Update api_rbac.md
rasika-chivate Aug 27, 2024
5cf5c49
Update api_rbac.md
rasika-chivate Aug 27, 2024
6ca7132
Update api_rbac.md
rasika-chivate Aug 27, 2024
cc9bd1a
Update mkdocs-base.yml
rasika-chivate Aug 27, 2024
a346a06
Update api_rbac.md
rasika-chivate Aug 28, 2024
21dbb5f
Update api_rbac.md
rasika-chivate Aug 28, 2024
3f2d07b
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
c936b16
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
a38b6eb
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
2c13d39
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
8a6df48
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
fb52139
Update api_rbac.md
rasika-chivate Aug 28, 2024
e45a9eb
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
32be466
Update upgrade_with_cli.md
rasika-chivate Aug 28, 2024
11ac638
Update docs/administer/api_rbac.md
rasika-chivate Sep 4, 2024
74dcba6
Update api_rbac.md
rasika-chivate Sep 4, 2024
425acc8
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 4, 2024
dd2632e
Update docs/administer/api_rbac.md
rasika-chivate Sep 4, 2024
62ea2df
Update api_rbac.md
rasika-chivate Sep 4, 2024
e69bd00
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 4, 2024
5c7bf4e
Update docs/upgrade_with_cli.md
rasika-chivate Sep 4, 2024
9b810f5
Update upgrade_with_cli.md
rasika-chivate Sep 4, 2024
03a7534
images for rbac
rasika-chivate Sep 5, 2024
5ef176c
Update rbac.md
rasika-chivate Sep 5, 2024
4a383d7
Update rbac.md
rasika-chivate Sep 5, 2024
58dda77
Update rbac.md
rasika-chivate Sep 5, 2024
fb2b333
Update rbac.md
rasika-chivate Sep 5, 2024
827cf25
Update rbac.md
rasika-chivate Sep 5, 2024
0109203
Update rbac.md
rasika-chivate Sep 5, 2024
e454a05
added ianges for readonly role
rasika-chivate Sep 5, 2024
56ea9d5
Update rbac.md
rasika-chivate Sep 5, 2024
84a41f7
Update rbac.md
rasika-chivate Sep 5, 2024
cf88620
Create rbac_storages_permissions.png
rasika-chivate Sep 5, 2024
8a009ea
Update rbac.md
rasika-chivate Sep 5, 2024
10b99c9
Update rbac.md
rasika-chivate Sep 5, 2024
421c546
Update rbac.md
rasika-chivate Sep 5, 2024
cee5837
Update rbac.md
rasika-chivate Sep 5, 2024
9f365b7
Update rbac.md
rasika-chivate Sep 5, 2024
9f05119
Update api_rbac.md
rasika-chivate Sep 9, 2024
620df0c
Update docs/administer/api_rbac.md
rasika-chivate Sep 9, 2024
adf6438
Update docs/administer/api_rbac.md
rasika-chivate Sep 9, 2024
c309e99
Merge branch 'Release-1.2.0' into RBAC
rasika-chivate Sep 9, 2024
3ce47c0
Update api_rbac.md
rasika-chivate Sep 9, 2024
4bc4ed7
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 9, 2024
6440ebd
Update docs/administer/api_rbac.md
rasika-chivate Sep 9, 2024
f399166
typo nd formating fixes
rasika-chivate Sep 9, 2024
74c31be
Update api_rbac.md
rasika-chivate Sep 9, 2024
79073df
Update rbac.md
rasika-chivate Sep 9, 2024
7ccaed7
Update docs/administer/rbac.md
rasika-chivate Sep 9, 2024
18d124b
Update docs/administer/rbac.md
rasika-chivate Sep 9, 2024
768a56c
Update docs/release-notes/Percona-Everest-1.1.0-(2024-08-12).md
rasika-chivate Sep 9, 2024
8835cf5
moved the API doc to reference section
rasika-chivate Sep 11, 2024
ea9c8d6
Update docs/administer/rbac.md
rasika-chivate Sep 11, 2024
c6bb1a0
Update mkdocs-base.yml
rasika-chivate Sep 11, 2024
7e7eb17
added a section for breaking API section and added link to the main t…
rasika-chivate Sep 11, 2024
71095cd
Update rbac.md
rasika-chivate Sep 11, 2024
91c6c16
Update docs/administer/rbac.md
rasika-chivate Sep 11, 2024
34c4ad9
Update docs/administer/rbac.md
rasika-chivate Sep 11, 2024
f846e93
Update rbac.md
rasika-chivate Sep 12, 2024
e590248
Update rbac.md
rasika-chivate Sep 12, 2024
f702077
Update rbac.md
rasika-chivate Sep 12, 2024
db8d705
Update rbac.md
rasika-chivate Sep 12, 2024
4d68e1e
Update rbac.md
rasika-chivate Sep 12, 2024
533c7fb
Update rbac.md
rasika-chivate Sep 20, 2024
6666a8a
Update rbac.md
rasika-chivate Sep 20, 2024
2a92023
Update rbac.md
rasika-chivate Sep 20, 2024
e3af1c3
Update rbac.md
rasika-chivate Sep 20, 2024
68f411b
Update rbac.md
rasika-chivate Sep 20, 2024
b46b564
Update rbac.md
rasika-chivate Sep 20, 2024
f5dadaf
Update rbac.md
rasika-chivate Sep 20, 2024
ee5392f
Update rbac.md
rasika-chivate Sep 20, 2024
0516e23
Update rbac.md
rasika-chivate Sep 20, 2024
825e341
Update rbac.md
rasika-chivate Sep 20, 2024
94870ae
Update rbac.md
rasika-chivate Sep 20, 2024
3f8a07c
Update rbac.md
rasika-chivate Sep 20, 2024
f5fa57b
Update rbac.md
rasika-chivate Sep 20, 2024
7c77c16
Update rbac.md
rasika-chivate Sep 20, 2024
229f65e
Update rbac.md
rasika-chivate Sep 20, 2024
a22460f
Update rbac.md
rasika-chivate Sep 20, 2024
83285bb
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
f4dd9bd
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
76bd86b
implenting feedback
rasika-chivate Sep 20, 2024
adf1058
Update rbac.md
rasika-chivate Sep 20, 2024
3d86030
Update rbac.md
rasika-chivate Sep 20, 2024
9ad2510
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
676260e
Update rbac.md
rasika-chivate Sep 20, 2024
d9c51fb
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 20, 2024
a694583
Update rbac.md
rasika-chivate Sep 20, 2024
b2dc0ab
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
5b9814c
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
84729f9
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
fb3732a
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
42a94c7
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
a01fb91
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
669cb30
Update docs/administer/rbac.md
rasika-chivate Sep 20, 2024
526e8a2
Update rbac.md
rasika-chivate Sep 20, 2024
3ee3519
Update rbac.md
rasika-chivate Sep 20, 2024
3cf3215
Update rbac.md
rasika-chivate Sep 20, 2024
fa2c090
Update rbac.md
rasika-chivate Sep 23, 2024
985c069
add examples
rasika-chivate Sep 23, 2024
8f18661
Update rbac.md
rasika-chivate Sep 23, 2024
c0173ed
Update rbac.md
rasika-chivate Sep 23, 2024
462ba13
Update rbac.md
rasika-chivate Sep 23, 2024
566e70b
Update rbac.md
rasika-chivate Sep 23, 2024
c90a162
Update rbac.md
rasika-chivate Sep 23, 2024
403759f
Update rbac.md
rasika-chivate Sep 23, 2024
9831a88
Update rbac.md
rasika-chivate Sep 23, 2024
6f9fa8f
Update rbac.md
rasika-chivate Sep 23, 2024
1aa41bd
Update rbac.md
rasika-chivate Sep 23, 2024
947e4f6
Update rbac.md
rasika-chivate Sep 23, 2024
09425fc
Update rbac.md
rasika-chivate Sep 23, 2024
ca9395a
Update rbac.md
rasika-chivate Sep 23, 2024
7fd5cce
Update rbac.md
rasika-chivate Sep 23, 2024
80ba0a1
Update rbac.md
rasika-chivate Sep 23, 2024
6652459
Update rbac.md
rasika-chivate Sep 23, 2024
f0e33c8
Update rbac.md
rasika-chivate Sep 23, 2024
69b28da
Update rbac.md
rasika-chivate Sep 23, 2024
667cbef
Update rbac.md
rasika-chivate Sep 23, 2024
dd93490
Update rbac.md
rasika-chivate Sep 23, 2024
a2b10d8
Update rbac.md
rasika-chivate Sep 23, 2024
06afaa6
Update rbac.md
rasika-chivate Sep 23, 2024
f1f485a
Update rbac.md
rasika-chivate Sep 23, 2024
be37049
Update rbac.md
rasika-chivate Sep 23, 2024
c9de7e8
Update rbac.md
rasika-chivate Sep 23, 2024
d492197
Update docs/administer/rbac.md
rasika-chivate Sep 23, 2024
fa5ba89
Update rbac.md
rasika-chivate Sep 23, 2024
b1faf08
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 23, 2024
9fcf11d
Update rbac.md
rasika-chivate Sep 23, 2024
b355579
Update rbac.md
rasika-chivate Sep 23, 2024
64a4c29
Update docs/administer/rbac.md
rasika-chivate Sep 23, 2024
d61da86
Update rbac.md
rasika-chivate Sep 23, 2024
7a2329c
fix typos
rasika-chivate Sep 24, 2024
64a7cd1
Update rbac.md
rasika-chivate Sep 24, 2024
357af92
Create Percona-Everest-1.2.0-(2024-09-09).md
rasika-chivate Sep 24, 2024
9a6df84
added tabs for examples for better readability
rasika-chivate Sep 24, 2024
b7bcc09
Update rbac.md
rasika-chivate Sep 24, 2024
1da5ac8
Update rbac.md
rasika-chivate Sep 24, 2024
f522227
Update rbac.md
rasika-chivate Sep 24, 2024
0e276f9
Update rbac.md
rasika-chivate Sep 24, 2024
ae2fdf9
Update rbac.md
rasika-chivate Sep 24, 2024
c33072a
Update rbac.md
rasika-chivate Sep 24, 2024
e908450
Update rbac.md
rasika-chivate Sep 24, 2024
c326814
Update rbac.md
rasika-chivate Sep 24, 2024
b6989d4
Update rbac.md
rasika-chivate Sep 24, 2024
f6040d0
Update rbac.md
rasika-chivate Sep 24, 2024
63391c8
Update docs/administer/rbac.md
rasika-chivate Sep 26, 2024
7dd28e6
Update docs/administer/rbac.md
rasika-chivate Sep 26, 2024
a22d6e1
Update rbac.md
rasika-chivate Sep 26, 2024
babbf13
Update docs/administer/rbac.md
rasika-chivate Sep 26, 2024
0785067
Update rbac.md
rasika-chivate Sep 26, 2024
ddb1221
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 26, 2024
48544dd
Merge branch 'Release-1.2.0' into RBAC
rasika-chivate Sep 26, 2024
d90814f
Update docs/administer/rbac.md
rasika-chivate Sep 26, 2024
934f0ea
Update rbac.md
rasika-chivate Sep 26, 2024
d3175b0
Merge branch 'RBAC' of https://github.com/percona/everest-doc into RBAC
rasika-chivate Sep 26, 2024
9dc537b
Update rbac.md
rasika-chivate Sep 26, 2024
9475b9f
Update rbac.md
rasika-chivate Sep 27, 2024
0d6de44
Update rbac.md
rasika-chivate Sep 27, 2024
e8d27f8
Update SetupPrereqs.md
rasika-chivate Sep 30, 2024
a6de12f
Update docs/administer/rbac.md
rasika-chivate Sep 30, 2024
f0ecd79
Update docs/administer/rbac.md
rasika-chivate Sep 30, 2024
bdb8183
Update docs/administer/rbac.md
rasika-chivate Sep 30, 2024
7872fc1
Update docs/administer/rbac.md
rasika-chivate Sep 30, 2024
334234b
Update rbac.md
rasika-chivate Sep 30, 2024
dbfa5ed
Update rbac.md
rasika-chivate Sep 30, 2024
b9787a2
Update rbac.md
rasika-chivate Sep 30, 2024
bfcbfa4
Update rbac.md
rasika-chivate Sep 30, 2024
410f802
Update rbac.md
rasika-chivate Sep 30, 2024
6c3def1
Update rbac.md
rasika-chivate Sep 30, 2024
7bff1d3
Update rbac.md
rasika-chivate Sep 30, 2024
acc45c6
Update rbac.md
rasika-chivate Sep 30, 2024
34f096f
Update rbac.md
rasika-chivate Sep 30, 2024
04390b0
Update rbac.md
rasika-chivate Sep 30, 2024
7c8e987
Update rbac.md
rasika-chivate Sep 30, 2024
2b9b0c1
Update rbac.md
rasika-chivate Sep 30, 2024
c70c508
Update docs/administer/rbac.md
rasika-chivate Oct 1, 2024
d0ddf39
Update docs/administer/rbac.md
rasika-chivate Oct 1, 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
2 changes: 2 additions & 0 deletions docs/administer/manage_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,10 @@ You will be prompted to enter the password for this user.
```

!!! info "Important"

For Percona Everest versions 1.0.0 and later, new users have full access to the system. However, once RBAC support is in place, an admin user will be able to manage permissions for users, granting them fine-grained control over database resources.

For detailed information on granting permissions to new users, see [assign permissions to a new user](rbac.md#assign-users-to-a-group-and-grant-them-permissions) section.

### List the users

Expand Down
435 changes: 435 additions & 0 deletions docs/administer/rbac.md

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions docs/api_rbac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Navigating the breaking API changes for RBAC

Starting with Percona Everest v1.2.0, breaking changes are being made to the API for `monitoring-instances` and `backup-storage` resources. These changes are:

- Before the release of Percona Everest 1.2.0, these resources were globally scoped, but now they will be specific to namespaces.

- The database clusters can only use `monitoring-instances` and `backup-storages` located within the same namespace as the cluster. The system used a `.spec.allowedNamespaces` field to control access to these global resources. This field determined the namespaces where the resource could be accessed, providing a certain degree of access control.

- With the update to Percona Everest v1.2.0, the shift from global scope to designated namespaces for these resources marks a significant change in the way access control is managed. This change enhances security by ensuring these resources are only accessible within their designated namespaces.

## Challenges with globally scoped namespaces

In Percona Everest v1.2.0, we’ve rolled out Role Based Access Control (RBAC) to enhance security and provide more granular control over the access privileges for specific resources within the system. This implementation provides fine-grained control over which users and user groups can access particular resources within the system.

The RBAC model functions on the principle that all resources are organized into namespaces. This enables a well-structured and hierarchical arrangement of resources, simplifying access rights management according to the namespace to which a resource is associated.

Prior to Percona Everest version 1.2.0, certain resources such as `backup-storages` and `monitoring-instances` were not organized into namespaces but were accessible globally. To enforce access restrictions on these globally scoped resources, the system utilized a `.spec.allowedNamespaces` field. The `.spec.allowedNamespaces` field specifies the namespaces within which the resource can be accessed, giving you certain level of control.

Using the `.spec.allowedNamespaces` field for globally scoped resources presented challenges when integrating with the core RBAC model. To fix this and align with the RBAC framework, `backup-storages` and `monitoring-instances` are now namespaced resources. This ensures that all resources conform to the same RBAC model, which results in a consistent and manageable access control structure across the system.

## Changes in the Percona Everest APIs

The APIs have been updated with the following modifications:

- The existing APIs for backup storage and monitoring instances are deprecated. Now, you should use the API path prefixed with `/namespaces/{namespace}`.

??? example "Example"

```/v1/backup-storages``` is now

```/v1/namespaces/{namespace}/backup-storages```

Check out the [API](https://percona-everest.readme.io/reference/getkubernetesclusterresources) documentation for more details.

- The `.spec.allowedNamespaces` field has been deprecated. Access control for these resources is now managed through the RBAC policy.

- `database-clusters` can now only reference `backup-storages` and `monitoring-instances` created within the same namespace as the `database-cluster`.

### Migrating to Percona Everest 1.2.0

When upgrading to 1.2.0, all your existing backup-storages and monitoring-instances will be automatically migrated to the namespaces specified in their `.spec.allowedNamespaces `fields. After the upgrade, these resources will be accessible exclusively through the new API endpoints.

Need more details? Check out the [upgrade](../upgrade_with_cli.md#upgrading-to-percona-everest-120) section.





Binary file added docs/images/datbase_view_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dev_role_db_cluster_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dev_role_monitor_read.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dev_role_storage_read.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/enable_sharding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_backup_permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_cluster_permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_monitoring_permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_readonly_ns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_readonly_role.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rbac_storages_permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/readonly_role_overview_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/sharding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions docs/install/SetupPrereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ Percona Everest has two primary components:

## Supported operators

* Percona Operator for MySQL Based on Percona XtraDB Cluster (PXC) 1.13.0, 1.14.0
* Percona Operator for MySQL Based on Percona XtraDB Cluster (PXC) 1.14.0, 1.15.0
* Percona Operator for MongoDB (PSMDB) 1.15.0
* Percona Operator for PostgreSQL (PG) 2.3.1
* Percona Operator for PostgreSQL (PG) 2.3.1, 2.4.1

## Supported k8s clusters

Percona Everest works on most of the cloud K8s and on most of the on-prem vanilla K8s.

However, not all the many combinations of K8s distributions and K8s versions might be fully tested and certified. Refer to the matrix below and [reach out to us](SetupPrereqs.md#get-expert-help) should you have any questions.

| Platform | Kubernetes Version | Percona Everest Version | State |
|:----------------------|:-------------------|:------------------------|:----------------------------------------|
| Google GKE | 1.24 - 1.28 | >= 1.0.0 | Fully tested and certified |
| Amazon EKS | 1.24 - 1.28 | >= 1.0.0 | Fully tested and certified |
| Vanilla K8s (kubeadm) | 1.24 - 1.28 | >= 1.0.0 | Fully tested and certified |
| Azure AKS | - | >= 1.0.0 | Works but not fully certified yet |
| DigitalOcean | - | >= 1.0.0 | Works but not fully certified yet |
| OpenShift | - | | Coming soon |
| Other cloud K8s | - | | Should work but not fully certified yet |
| Platform | Kubernetes Version | State |
|:----------------------|:-------------------|:----------------------------------------|
| Google GKE | 1.27 - 1.29 | Fully tested and certified |
| Amazon EKS | 1.28 - 1.30 | Fully tested and certified |
| Azure AKS | - | Works but not fully certified yet |
| DigitalOcean | - | Works but not fully certified yet |
| Vanilla K8s (kubeadm) | - | Works but not fully certified yet |
| OpenShift | - | Coming soon |
| Other cloud K8s | - | Should work but not fully certified yet |

!!! note
Air-gapped environments (i.e. environments physically isolated from unsecured networks such as the public Internet) are not currently supported. Their support is coming soon.
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/Percona-Everest-1.1.0-(2024-08-12).md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ curl -sS "https://raw.githubusercontent.com/percona/everest-doc/main/tools/bin/c

What to do if you have schedules or backups that are using duplicated storages in different database technologies.

=== ":simple-mongodb: MongoDB :simple-mysql: MySQL"
=== ":simple-mongodb: MongoDB or :simple-mysql: MySQL"

Create a new backup using a different backup storage. Then, delete the old schedules and backups that use the duplicated storage.

Expand Down
1 change: 1 addition & 0 deletions docs/release-notes/release_notes_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@


- [Percona Everest 1.1.1 (2024-08-22)](Percona-Everest-1.1.1-(2024-08-22).md)
- [Percona Everest 1.2.0 (2024-09-12)](Percona-Everest-1.2.0-(2024-09-12).md)
- [Percona Everest 1.1.0 (2024-08-12)](Percona-Everest-1.1.0-(2024-08-12).md)
- [Percona Everest 1.0.1 (2024-07-08)](Percona-Everest-1.0.1-(2024-07-08).md)
- [Percona Everest 1.0.0 (2024-06-28)](Percona-Everest-1.0.0-(2024-06-28).md)
Expand Down
97 changes: 96 additions & 1 deletion docs/upgrade_with_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,112 @@ During the upgrade of Percona Everest, only Everest and Everest operator are upg
2024-05-03T12:07:28Z info upgrade/upgrade.go:148 Everest has been upgraded to version 0.10.0 {"component": "upgrade"}
```

3. After upgrading, refresh the Percona Everest UI to access the new version.


### Upgrading to Percona Everest 1.2.0

3. After upgrading, refresh the Percona Everest UI to access the new version.
When upgrading to 1.2.0 using the CLI command `everestctl upgrade`, all your existing backup storages and monitoring instances will be automatically migrated to the namespaces specified in their `.spec.allowedNamespaces` fields.

Following the upgrade, your databases should not experience any downtime. Your backup, restore, and monitoring functionalities should continue to operate normally.

In the unlikely event that your upgrade fails, and you need to manually migrate these resources, follow the steps in [how to resolve upgrade failures in Percona Everest 1.2.0](#how-to-resolve-upgrade-failures-in-percona-everest-120) section.


## How to address a failed upgrade

If the upgrade fails, you can attempt it again. If the issue persists, [create a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository).

### Resolving upgrade failures due to the breaking API changes in Percona Everest 1.2.0

Percona Everest 1.2.0 includes some [breaking API changes](administer/api_rbac.md#navigating-the-breaking-api-changes-for-rbac). While all your resources will be migrated automatically, in the unlikely event that your upgrade fails and you need to manually migrate these resources, follow the steps below:
{.power-number}

1. List the existing backup-storages:

```
kubectl get backupstorages -n everest-system -oyaml > new-backupstorages.yaml
```

2. Check whether the backup storage has been retrieved.

```sh
cat new-backupstorages.yaml

apiVersion: everest.percona.com/v1alpha1
kind: BackupStorage
metadata:
name: s3
namespace: everest-system
spec:
allowedNamespaces:
- my-cool-namespace
- another-cool-namespace
bucket: my-cool-bucket
credentialsSecretName: s3
description: s3
endpointURL: https://s3.us-west-2.amazonaws.com
forcePathStyle: false
region: us-west-2
type: s3
verifyTLS: true
```

!!! note
You may see more than one object, depending on the number of objects created.


3. Edit `new-backupstorages.yaml` as follows:

1. For each `BackupStorage` retrieved, create a copy in each namespace specified under `.spec.allowedNamespaces`.

2. Remove (or unset) `.spec.allowedNamespaces` in each copy of the `BackupStorages` object.

3. Ensure that `.metadata` contains only `name` and `namespace`.

??? example "Example"
```sh
apiVersion: everest.percona.com/v1alpha1
kind: BackupStorage
metadata:
name: s3
namespace: my-cool-namespace
spec:
allowedNamespaces: []
bucket: my-cool-bucket
credentialsSecretName: s3
description: s3
endpointURL: https://s3.us-west-2.amazonaws.com
forcePathStyle: false
region: us-west-2
type: s3
verifyTLS: true
---
apiVersion: everest.percona.com/v1alpha1
kind: BackupStorage
metadata:
name: s3
namespace: another-cool-namespace
spec:
allowedNamespaces: []
bucket: my-cool-bucket
credentialsSecretName: s3
description: s3
endpointURL: https://s3.us-west-2.amazonaws.com
forcePathStyle: false
region: us-west-2
type: s3
verifyTLS: true
```

4. Create your new backup storages:

kubectl apply -f new-backupstorages.yaml

A similar set of steps can also be followed for monitoring configs as well:

kubectl get monitoringconfigs -n everest-monitoring > new-monitoringconfigs.yaml


## After your upgrade is complete

Expand Down
4 changes: 4 additions & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,9 @@ nav:
- Administer:
- User management: administer/manage_users.md
- Single sign-on (SSO): administer/Idp_integration.md
- Access Control:
- RBAC: administer/rbac.md


- Use:
- Database view: use/database_view.md
Expand All @@ -197,6 +200,7 @@ nav:
- API rate limiting: use/API_rate_limit.md
- API: API.md
- Reference:
- Breaking API changes: api_rbac.md
- Limitations: reference/known_limitations.md
- Telemetry on Percona Everest: reference/telemetry.md
- Migrate to Percona Everest: reference/migration_guide.md
Expand Down
Loading