renku login

Logging in to a Renku deployment.

Description

Authenticate with a remote Renku deployment. This command will bring up a browser window where you can log in using your credentials. Renku CLI receives and stores a secure token that will be used for future authentications.

Commands and options

renku login

Log in to the platform.

renku login [OPTIONS] [ENDPOINT]

Options

--no-git

Don’t log in to gitlab.

--yes

Do not warn users about remote URL change.

Arguments

ENDPOINT

Optional argument

Examples

$ renku login <endpoint>

Parameter endpoint is the URL of the Renku deployment that you want to authenticate with (e.g. renkulab.io). You can either pass this parameter on the command-line or set it once in project’s configuration:

$ renku config set endpoint <endpoint>

Note

The secure token is stored in plain-text in Renku’s global configuration file on your home directory (~/.renku/renku.ini). Renku changes access rights of this file to be readable only by you. This token exists only on your system and won’t be pushed to a remote server.

By default, this command also logs you into gitlab server for project’s repository. You can use this method instead of creating an SSH key. This will change the repository’s remote URL to an endpoint in the deployment that adds authentication to gitlab requests. Renku warns you each time that the remote URL will change. To disable this warning, either pass --yes to the command or set show_login_warning to false for the project or globally:

$ renku config set [--global] show_login_warning false

You can avoid the remote from being changed by passing --no-git option to the login command.

Note

Project’s remote URL will be changed when logging in to Renku. Changes are undone when logging out from renku in the CLI. Original remote URL will be stored in a remote with name renku-backup-<remote-name>.

Logging out from Renku removes the secure token from your system:

$ renku logout <endpoint>

If you don’t specify an endpoint when logging out, credentials for all endpoints are removed.