Skip to content

[OSL-4718] Improve token documentation - #80

Merged
bbuechler merged 2 commits into
mainfrom
bb/add-token-docs
Jul 31, 2026
Merged

bbuechler merged 2 commits into
mainfrom
bb/add-token-docs

Conversation

@bbuechler

Copy link
Copy Markdown
Contributor

No description provided.

| Stack name | The CloudFormation stack name. For readablity, append `-pipeline` to the end. |
| CodeStarConnectionArn | The ARN of the Connection made eariler. |
| CostTagKey | Useful if using billing allocation tags. |
| CostTagValue | Useful if using billing allocation tags. Note that many resources will have this in their name for uniqueness. It needs to be short in length. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thats wild. All I did was change "USeful" to "Useful" and Pycharm auto-formatted the rest?

| CodeStarConnectionArn | The ARN of the Connection made eariler. |
| ContainerNamespace | The ECR prefix acting as a namespace for the images. This will be needed for the cluster's `opensarlab.yaml`. |
| CostTagKey | Useful if using billing allocation tags. |
| CostTagValue | Useful if using billing allocation tags. Note that many resources will have this in their name for uniqueness. It needs to be short in length. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same as above


If access needs to be re-granted to a user after they have been removed post token application, they may still be added following the process in [Adding/Updating Users](#adding-updating-users) below.
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The context screenshot is 🔥


After expiration of a token, it can no longer be applied for access. A user granted access with a token does not lose access after the token expires.
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Image

- Enter provided token value and click **Apply Token**

- If token is valid, you will immediately be granted access to the lab

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Image

- Enter provided token value and click **Apply Token**

- If token is valid, you will immediately be granted access to the lab, and the lab will be available from the portal landing page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Image

@bbuechler bbuechler changed the title [OSL-2090] Improve token documentation [OSL-4718] Improve token documentation Jul 31, 2026
Comment thread user-guides/custom_deployment_access.md

@dgpalmieri dgpalmieri left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One suggestion, otherwise everything looks great! 🎉


### Lab Access Tokens

Lab instructions may provide an easy access token.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Lab instructions may provide an easy access token.
Lab instructors may provide an easy access token.

@bbuechler
bbuechler merged commit b9d9069 into main Jul 31, 2026
3 checks passed
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