{"id":18637081,"url":"https://github.com/openshift/rosa","last_synced_at":"2025-04-08T00:36:30.295Z","repository":{"id":36952119,"uuid":"249552331","full_name":"openshift/rosa","owner":"openshift","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T12:06:54.000Z","size":66987,"stargazers_count":86,"open_issues_count":22,"forks_count":200,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-10-29T14:35:37.738Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openshift.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-23T21:53:10.000Z","updated_at":"2024-10-29T12:06:59.000Z","dependencies_parsed_at":"2023-02-14T19:16:45.223Z","dependency_job_id":"279cb1d2-cd16-446b-a7bc-e9e8154cd607","html_url":"https://github.com/openshift/rosa","commit_stats":null,"previous_names":["openshift/moactl"],"tags_count":179,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frosa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frosa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frosa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frosa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openshift","download_url":"https://codeload.github.com/openshift/rosa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247755560,"owners_count":20990620,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T05:33:09.838Z","updated_at":"2025-04-08T00:36:30.272Z","avatar_url":"https://github.com/openshift.png","language":"Go","readme":"# Red Hat OpenShift Service on AWS (ROSA) Command Line Tool\n\nThis project contains the `rosa` command line tool that simplifies the use of Red Hat OpenShift Service on AWS, also known as _ROSA_.\n\n## Quickstart guide\n\nRefer to the official ROSA documentation: https://access.redhat.com/products/red-hat-openshift-service-aws\n\n1. Follow the [AWS Command Line Interface](https://aws.amazon.com/cli/) documentation to install and configure the AWS CLI for your operating system.\n2. Download the [latest release of rosa](https://github.com/openshift/rosa/releases/latest) and add it to your path.\n3. Initialize your AWS account by running `rosa init` and following the instructions.\n4. Create your first ROSA cluster by running `rosa create cluster --interactive`\n\n## Build from source\n\nIf you'd like to build this project from source use the following steps:\n\n1. Clone the repository\n\n```\ngit clone https://github.com/openshift/rosa.git\n```\n\n2. `cd` to the checkout out source directory\n\n```\ncd rosa\n```\n\n3. Install the binary\n\n```\nmake install\n```\n\nNOTE: If you don't have `$GOPATH/bin` in your `$PATH` you need to add it or move `rosa` to a standard system directory eg. for Linux/OSX:\n\n```\nsudo mv $GOPATH/bin/rosa /usr/local/bin\n```\n## Try the ROSA cli from binary\n\nIf you don't want to build from sources you can retrieve the `rosa` binary from the latest image.\n\nYou can copy it to your local with this command:\n\n```\npodman run --pull=always --rm registry.ci.openshift.org/ci/rosa-aws-cli:latest cat /usr/bin/rosa \u003e ~/rosa \u0026\u0026 chmod +x ~/rosa\n```\n\nAlso you can test a binary created after a specific merged commit just using the commit hash as image tag:\n\n```\npodman run --pull=always --rm registry.ci.openshift.org/ci/rosa-aws-cli:f7925249718111e3e9b61e2df608a6ea9cf5b6ce cat /usr/bin/rosa \u003e ~/rosa \u0026\u0026 chmod +x ~/rosa\n```\n\nNOTE: There is a side-effect of container image registry authentication which results in an [auth error](https://docs.ci.openshift.org/docs/how-tos/use-registries-in-build-farm/#why-i-am-getting-an-authentication-error) when your token is expired even when the image requires no authentication. In that case all you need to do is authenticate again:\n```\n$ oc registry login\ninfo: Using registry public hostname registry.ci.openshift.org\nSaved credentials for registry.ci.openshift.org\n\n$ cat ~/.docker/config.json | jq '.auths[\"registry.ci.openshift.org\"]'\n{\n  \"auth\": \"token\"\n}\n```\n## Secure Credentials Storage\nThe `OCM_KEYRING` environment variable provides the ability to store the ROSA \nconfiguration containing your authentication tokens in your OS keyring. This is provided\nas an alternative to storing the configuration in plain-text on your system. \n`OCM_KEYRING` will override all other token or configuration related flags.\n\n`OCM_KEYRING` supports the following keyrings:\n\n* [Windows Credential Manager](https://support.microsoft.com/en-us/windows/accessing-credential-manager-1b5c916a-6a16-889f-8581-fc16e8165ac0) - `wincred`\n* [macOS Keychain](https://support.apple.com/en-us/guide/keychain-access/welcome/mac) - `keychain`\n* Secret Service ([Gnome Keyring](https://wiki.gnome.org/Projects/GnomeKeyring), [KWallet](https://apps.kde.org/kwalletmanager5/), etc.) - `secret-service`\n* [Pass](https://www.passwordstore.org/) - `pass`\n\nTo ensure `OCM_KEYRING` is provided to all `rosa` commands, it is recommended to set it in your `~/.bashrc` file or equivalent.\n\n| | wincred | keychain | secret-service | pass |\n| ------------- | ------------- | ------------- | ------------- | ------------- |\n| Windows  | :heavy_check_mark: | :x:  | :x:  | :x:  |\n| macOS  | :x:  | :heavy_check_mark:  | :x:  | :heavy_check_mark:  |\n| Linux  | :x:  | :x:  | :heavy_check_mark: | :heavy_check_mark: |\n## Have you got feedback?\n\nWe want to hear it. [Open an issue](https://github.com/openshift/rosa/issues/new) against the repo and someone from the team will be in touch.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Frosa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenshift%2Frosa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Frosa/lists"}