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

[Docs] Configuring API gateway with SDK #5722

Merged
merged 10 commits into from
Jul 7, 2024

Conversation

jillnogold
Copy link
Member

@jillnogold jillnogold commented Jun 5, 2024

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

docs/concepts/nuclio-real-time-functions.ipynb Outdated Show resolved Hide resolved
docs/serving/canary.md Outdated Show resolved Hide resolved
docs/serving/canary.md Show resolved Hide resolved
Copy link
Member

@TomerShor TomerShor left a comment

Choose a reason for hiding this comment

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

@jillnogold Looking good overall!
it might be worth adding an access key authentication example which authenticates users via the Iguazio Backend.
Usage is as simple as:

my_api_gateway.with_access_key_auth()

@jillnogold
Copy link
Member Author

@TomerShor - would that look like: (first 2 auth already in the doc. New one in bold)

Create a simple Nuclio function that gets basic authentication

basic_auth = project.set_function(
name="basic-auth", handler="handler", image="mlrun/mlrun", kind="nuclio"
)

Create a simple nuclio function that gets accesss key authentication

access_key_auth = project.set_function(
name="acces-key", handler="handler", image="mlrun/mlrun", kind="nuclio"
)
# Add an access key authentication example that authenticates users via the Iguazio Backend
my_api_gateway.with_access_key_auth()

@TomerShor
Copy link
Member

@TomerShor - would that look like: (first 2 auth already in the doc. New one in bold)

Create a simple Nuclio function that gets basic authentication

basic_auth = project.set_function( name="basic-auth", handler="handler", image="mlrun/mlrun", kind="nuclio" )

Create a simple nuclio function that gets accesss key authentication

access_key_auth = project.set_function( name="acces-key", handler="handler", image="mlrun/mlrun", kind="nuclio" ) # Add an access key authentication example that authenticates users via the Iguazio Backend my_api_gateway.with_access_key_auth()

If only the bold stays and all else doesn't that's ok.

We should have examples for:

  1. basic auth:
# Add basic authorization configuration:
my_api_gateway.with_basic_auth(
    username="test",
    password="pass",
)
  1. access key auth:
# Add an access key authentication example that authenticates users via the Iguazio Backend
my_api_gateway.with_access_key_auth()

@TomerShor TomerShor merged commit a836162 into mlrun:development Jul 7, 2024
11 checks passed
@jillnogold jillnogold deleted the ml-2652-api-gateway branch October 7, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants