Skip to content

Add OKE signer example to docs #51

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.

Sign up for GitHub

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

Open
ahosler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add OKE signer example to docs #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion docs/source/getting-connected.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
"Users can provide default authentication configuration details as enviornment variables.\n",
"The following environment variables are inspected:\n",
"\n",
"* `OCIFS_IAM_TYPE`: which can be any of: [\"api_key\", \"resource_principal\", \"instance_principal\", \"unknown_signer\"]\n",
"* `OCIFS_IAM_TYPE`: which can be any of: [\"api_key\", \"resource_principal\", \"instance_principal\", \"oke_principal\", \"unknown_signer\"]\n",
"* `OCIFS_CONFIG_LOCATION`: (optional) will be referenced in the case of \"api_key\", but defaults to the default config location provided by the oci sdk\n",
"* `OCIFS_CONFIG_PROFILE`: (optional) will be referenced in the case of \"api_key\", but defaults to the default config profile provided by the oci sdk\n"
]
Expand Down Expand Up @@ -190,6 +190,17 @@
"fs_ip = OCIFileSystem(signer=instance_principal_signer)"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "manufactured-poisson",
"metadata": {},
"outputs": [],
"source": [
"oke_principal = oci.auth.signers.get_oke_workload_identity_resource_principal_signer()\n",
"fs_ip = OCIFileSystem(signer=oke_principal)"
]
},
{
"cell_type": "markdown",
"id": "terminal-christmas",
Expand Down