gh-aws-oidc

command module
v0.0.0-...-fd37ffa Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2022 License: Apache-2.0 Imports: 1 Imported by: 0

README

gh-aws-oidc

This is a Github CLI extension to setup a federated OIDC based connection between a repository, organization or an environment and AWS Services.

Usage instructions

Note: Before you run the CLI, run aws configure. You will need the Access Key combinations to connect initially to AWS. aws configure will create a config file under ~/.aws/config. Once you complete this CLI, you can remove the AWS credentials by deleting the folder

gh aws-oidc [flags]

    Options
        --o <organization>
        Select a organization to connect to AWS
        --e <environment>
        Select an environment under the repository 
        --useDefaults
        This will skip the interactive flow and select the defaults on aws side to setup connection quickly (Not implemented yet, work in progress)

    Options inherited from parent commands
        -R, --repo <[HOST/]OWNER/REPO>
        Select another repository using the [HOST/]OWNER/REPO format


Examples
# Setup connection at a repo level (assuming user is in the git folder)
$ gh aws-oidc

# Setup connection at an organization level
$ gh aws-oidc -o myorg

# Setup connection at a repo level
$  gh aws-oidc -R myorg/myrepo

# Setup connection at a repo and environment level
$  gh aws-oidc -R myorg/myrepo -e myenvironment

Demo

To run this application, execute below command

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL