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

Feature/Enterprise#232 - Add documentation for running Orchestrator service using a specific Credentials #1245

Merged
Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ additional features.
[Authorize with SystemCredentials](../userman/advanced_features/auth/authorization.md#authorize-with-systemcredentials)
for more details.

- The `Orchestrator^` service can now be run with a specific `Credentials^` instead of the
default `SystemCredentials^`. See the
[Run the Orchestrator service with specific Credentials](../userman/advanced_features/auth/authorization.md#run-the-orchestrator-service-with-specific-credentials)
for more details.

## Significant bug fixes

- No bug fix.
Expand Down
25 changes: 24 additions & 1 deletion docs/userman/advanced_features/auth/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ with Authorize(credentials):

## Authorize with SystemCredentials

`SystemCredentials^` are special `Credentials^` that have the TAIPY_ADMIN role.
`SystemCredentials^` are special `Credentials^` that have the "TAIPY_ADMIN" role.

The `SystemCredentials^` can be used for administrative actions when there is no
authenticated user. Typical use cases include:
Expand All @@ -305,3 +305,26 @@ with Authorize(SystemCredentials()):
# from the SystemCredentials
...
```

# Run the Orchestrator service with specific Credentials

Running the Orchestrator service requires authorization with the `TAIPY_EXECUTOR` role.
trgiangdo marked this conversation as resolved.
Show resolved Hide resolved

You can specify which `Credentials^` will be used to authorize the actions performed by
running the Orchestrator service.
trgiangdo marked this conversation as resolved.
Show resolved Hide resolved

```python
from taipy.auth import Authorize, login
from taipy import Orchestrator

# Get a valid Credentials from Authentication
credentials = login("user1", "pass123")

orchestrator = Orchestrator()
with Authorize(credentials):
orchestrator.run()
...
```

If not specified, running the Orchestrator service will use the `SystemCredentials^` to authorize
for the actions needed to start the service.
Loading