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

Document replacing credentials in a basic auth setup #8491

Merged
merged 3 commits into from
Jan 14, 2025
Merged
Changes from 1 commit
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
28 changes: 28 additions & 0 deletions docs/security/access-control-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,34 @@ Existing lakeFS installations that have a single user and a single set of creden
Installations that have more than one user / credentials will require to run a command and choose which set of user + credentials to migrate
(more details [here](#migration-of-existing-user))

### Replacing credentials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Credentials Replacement


To replace the credentials of the (single) user in a lakefs installation:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To replace the credentials of the (single) user in a lakefs installation:
In non-ACL setup (single user) to replace the credentials in a lakefs installation:

1. Delete the existing user:
```shell
lakectl auth users delete --id <user-id>
```
2. Shut down the lakeFS server - Required for invalidating the old credentials on the server
3. Create a new user, with the same name and new credentials:
```shell
lakefs superuser --user-name <user-id>
```
This will generate a new set of credentials, and will print it out to the screen:
```
credentials:
access_key_id: *** (omitted)
secret_access_key: *** (omitted)
```
4. Re-run lakeFS server

{: .note .warning}
> Calling the `superuser` command with `--access-key-id` and without `--secret-access-key` will make lakefs try to
> import an existing user (see [Migration of existing user](#migration-of-existing-user)).
> In case you already deleted the user by following step (1), this import operation will **fail** and result in an
> **unrecoverable** state, and a clean installation is the only way out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Calling the `superuser` command with `--access-key-id` and without `--secret-access-key` will make lakefs try to
> import an existing user (see [Migration of existing user](#migration-of-existing-user)).
> In case you already deleted the user by following step (1), this import operation will **fail** and result in an
> **unrecoverable** state, and a clean installation is the only way out.
> Calling the `superuser` command with pre-defined `--access-key-id` and `--secret-access-key` is possible but should be done with caution. Make sure that `--secret-access-key` is **not empty**, It's suitable for ACL's
> import an existing user (see [Migration of existing user](#migration-of-existing-user)).
> In case you already deleted the user by following step (1), this import operation will **fail** and result in an
> **unrecoverable** state, and a clean installation is the only way out.

>
> In general, replacing credentials is a risky operation. Proceed with caution.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what is the value of this sentence, I would remove it (up to you)


## ACLs

ACL server was moved out of core lakeFS and into a new package under `contrib/auth/acl`.
Expand Down
Loading