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

Update aws-codecommit.md #1523

Closed
wants to merge 0 commits into from
Closed

Update aws-codecommit.md #1523

wants to merge 0 commits into from

Conversation

gopikrishna7
Copy link

@gopikrishna7 gopikrishna7 commented Jun 13, 2023

Added info regarding creating source from the AWS CodeCommit

@gopikrishna7
Copy link
Author

@stefanprodan Please review

@@ -87,6 +87,24 @@ protocol](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_ss
Use the [RFC 3986 compatible syntax](https://tools.ietf.org/html/rfc3986#section-3) instead: `git-codecommit.<region>.amazonaws.com/v1`.
{{% /alert %}}

## Create source from the CodeCommit
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe be more explicit?

Suggested change
## Create source from the CodeCommit
## Create GitRepository Source from CodeCommit Repository

Comment on lines 92 to 94
1. You need to create key manually upload that key to the IAM user.
2. Make a note of the user ID for which you have uploaded the key
3. When creating the source you need to specify the userid in the `Url`, `private-key-file` and `ssh-key-algorithm`
Copy link
Contributor

Choose a reason for hiding this comment

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

The installation section above shows how to use aws iam upload-ssh-public-key to upload ssh key. Maybe refer to that and follow the same names, instead of user ID, SSHPublicKeyID. The same placeholders can be used in the create source code snippet below.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, since this is about ssh, how about adding another section about HTTP auth and how to get the IAM credentials for it?

To create the source from Code-Commit run the following command:
```sh
flux create source git flux-system \
--git-implementation=libgit2 \
Copy link
Contributor

Choose a reason for hiding this comment

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

Git implementation should no longer be needed.


To create the source from Code-Commit run the following command:
```sh
flux create source git flux-system \
Copy link
Contributor

Choose a reason for hiding this comment

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

It's likely that flux-system GitRepository source already exists with the bootstrapped repository. Name use a placeholder instead of flux-system here.

Comment on lines 102 to 103
--private-key-file=./codecommit_rsa \
--ssh-key-algorithm=rsa \
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's use placeholder here as well, similar to the placeholders in the installation section above.

@darkowlzz darkowlzz added the area/docs Documentation related issues and pull requests label Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants