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: Add tctl plugins install refrerence #52878

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

tcsc
Copy link
Contributor

@tcsc tcsc commented Mar 7, 2025

No description provided.

@tcsc tcsc temporarily deployed to docs-amplify March 7, 2025 07:18 — with GitHub Actions Inactive
@github-actions github-actions bot added no-changelog Indicates that a PR does not require a changelog entry size/sm labels Mar 7, 2025
Copy link

github-actions bot commented Mar 7, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
tcsc/ic-plugin-install-docs eb06333 5 ✅SUCCEED tcsc-ic-plugin-install-docs 2025-03-08 06:33:45

Copy link
Collaborator

@r0mant r0mant left a comment

Choose a reason for hiding this comment

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

Some things need to be fixed, requesting changes so we don't accidentally merge inaccurate docs.


### Flags

| Name | Default Value(s) | Allowed Value(s) | Description |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we have a column that says which flag is required and which is optional?

| `--scim-token` | none | text | The AWS Identify Center SCIM provisioning access bearer token. |
| `--instance-arn` | none | ARN | The ARN of the Identity Center instance to manage |
| `--instance-region` | none | text | The AWS region where the Identity Center instance is located. |
| `--[no-]use-system-credentials` | `--no-use-system-credentials` | none | Use system AWS credentials to authenticate with AWS. Note that currently only `--use-system-credentials` is supported by `tctl`. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Note that currently only --use-system-credentials is supported by tctl.

This is a little confusing. Does this mean to say that "tctl" supports only use-system-creds, or that use-system-creds is only supported by tctl and not web UI currently? I assume it's the latter, in which case it feels like the word "only" should move.

Suggested change
| `--[no-]use-system-credentials` | `--no-use-system-credentials` | none | Use system AWS credentials to authenticate with AWS. Note that currently only `--use-system-credentials` is supported by `tctl`. |
| `--[no-]use-system-credentials` | `--no-use-system-credentials` | none | Use system AWS credentials to authenticate with AWS. Note that currently `--use-system-credentials` is only supported by `tctl`. |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Technically, both


### Flags

| Name | Default Value(s) | Allowed Value(s) | Description |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment as above w/r/t required vs optional arguments.

Comment on lines 2088 to 2089
--default-owner admin \
--default-owner [email protected] \
Copy link
Collaborator

Choose a reason for hiding this comment

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

In the table above it says this flag name is --access-list-default-owner.

Can you please re-verify all flags are accurate?

| - | - | - | - |
| `--name` | `okta` | text | Name of the plugin resource to create. |
| `--org` | none | URL | URL of Okta organization. |
| `--api-token` | none | text | Okta API token for the plugin to use. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

API tokens for Okta integration are deprecated. We're using API service app now with OAuth 2.0 auth. Does the command support it?

cc @kopiczko

@tcsc tcsc temporarily deployed to docs-amplify March 8, 2025 06:18 — with GitHub Actions Inactive
@tcsc tcsc temporarily deployed to docs-amplify March 8, 2025 06:19 — with GitHub Actions Inactive
@tcsc tcsc temporarily deployed to docs-amplify March 8, 2025 06:20 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants