This document describes the relevant changes between releases of the
ocm
command line tool.
- 165b90e OCM-4783 | feat: display warnings after cluster creation
- 0973f7b Display a cluster history URL in cluster describe
- ad98440 Fix minor formatting issue with cluster describe
- ea1c988 OCM-4962 | Feat | Add OAuth login using PKCE (#590)
- 98944f7 OCM-5759 | feat: Add Device Code Flow (#591)
- ff1c142 Display only platform-relevant field in cluster describe
- fab7ccf OCM-5281 | Feat | Add region validation from ocm-shards and list regions command (#586)
- f279dc7 Use Hostname() to set --hosted-domain
- d0f8459 improving ocm login and ocm list rh-region url resolution to reuse the url saved in config before falling back to api.openshift.com
- d894c2a OCM-6407 | edit option sends an empty payload
- 9cf11ef OCM-6450 | No update cluster with empty config
- 1caf2d0 OCM-5941 | add enable delete protection parameter
- a056c70 OCM-6140 | feat: allow customization of the domain prefix when creating a cluster
- 5aa159f OCM-6030 | chore: bump sdk to v0.1.407
- 03500fe OCM-6140: make name width to be 54 chars to fix truncation issue in case of longer name > 28 chars
- 6d1fd05 OCM-6030 | feat: allow to edit component routes of ingress
- 383d362 Make auth and device code flags visible
- OCM-4960: Do not print expiration timestamp if not set
- OCM-5131 | feat: add SG IDs to describe cluster and list machinepools
- Add 'secure-boot-for-shielded-vms' flag to expose secureboot on GCP
- OCM-5131 | fix: don't show additional compute SGs describing cluster
- OCM-4750 | feat: additional security group ids attributes
- 4dad47f OCM-3510 | fix: allow clusters to edit ingresses
- 57855bf fixed setting isGcpMarketplaceSubscriptionType for non interactive mode
- 557a66b making GCP service account file mandatory for CCS clusters (#565)
- 1f5481b Add GCP marketplace terms and conditions for marketplace GCP clusters
- 47cd35c showing error and re-prompting service-account-file question if one is not provided (#567)
- 0d3f4c3 OCM-4186 | Feat | Changed marketplace-gcp-terms error message for non-interactive mode (#569)
- 455f27e OCM-4184 | Feat | Convert relative path containing tilde for service account file (#568)
- 447488d Added default values for CIDRs and host prefix
- 1f2b39b fix duplicate machine pool information printed for the same cluster
- f0fadd8 add tests for list machinepools command
- 5b60bbf added failure tests for list machinepools command
- 498c54e Filtered OCM versions for marketplace gcp clusters
- Bump k8s.io/apimachinery from 0.27.2 to 0.27.3
- Bump github.com/onsi/ginkgo/v2 from 2.9.7 to 2.11.0
- Bump golang.org/x/text from 0.9.0 to 0.11.0
- Bump golang.org/x/term from 0.8.0 to 0.10.0
- Bump github.com/AlecAivazis/survey/v2 from 2.3.6 to 2.3.7
- Bump github.com/openshift-online/ocm-sdk-go from 0.1.344 to 0.1.367
- Improve GetCluster message when Subscription exists but is inactive
- OCM-2657 | feat: day1/2 operations for managed ingress attributes
- Bump github.com/openshift/rosa from 1.2.22 to 1.2.24
- OCM-2941| fix: Adjusting help usage and ingress builder call
- OCM-2942 | fix: adjust help usage for cluster routes attributes
- OCM-2966 : Feat : Added subscription_type parameter to create cluster command
- OCM-3061 | fix: allow to reset route selectors/excluded namespaces
- Bump github.com/onsi/ginkgo/v2 from 2.8.1 to 2.9.1
- Add display name to describe output
- Bump github.com/onsi/gomega from 1.27.3 to 1.27.6
- Update linting configuration
- Add HCP status to list/describe output
- Bump k8s.io/apimachinery from 0.26.1 to 0.27.1
- Bump github.com/openshift/rosa from 1.2.15 to 1.2.17
- Bump golang.org/x/term from 0.6.0 to 0.7.0
- Bump github.com/spf13/cobra from 1.6.1 to 1.7.0
- Update copr build instructions
- Bump github.com/onsi/ginkgo/v2 from 2.9.2 to 2.9.7
- Bump k8s.io/apimachinery from 0.27.1 to 0.27.2
- Bump github.com/openshift-online/ocm-sdk-go from 0.1.330 to 0.1.344
- Bump github.com/openshift/rosa from 1.2.17 to 1.2.22
- OCM-2177 | Add additional status details to the describe cluster output
- docs: update the installation w/ 'go install'
- Update brew installation instructions
- Add dependabot config
- Update github actions
- Upgrade dependencies
- Bump github.com/spf13/cobra from 1.5.0 to 1.6.1
- Bump github.com/openshift-online/ocm-sdk-go from 0.1.306 to 0.1.308
- Update revocation link
- Remove validation for GCP+private clusters
- Add build artifact for darwin/arm64
- Bump k8s.io/apimachinery from 0.24.3 to 0.26.1
- Bump github.com/onsi/gomega from 1.24.2 to 1.25.0
- Bump github.com/onsi/ginkgo/v2 from 2.7.0 to 2.8.0
- Bump golang.org/x/text from 0.6.0 to 0.7.0
- Bump golang.org/x/term from 0.4.0 to 0.5.0
- Bump github.com/onsi/gomega from 1.25.0 to 1.26.0
- Bump github.com/openshift-online/ocm-sdk-go from 0.1.308 to 0.1.316
- Bump github.com/openshift/rosa from 1.2.11 to 1.2.15
- Bump golang.org/x/net from 0.5.0 to 0.7.0
- Bump github.com/golang-jwt/jwt/v4 from 4.4.3 to 4.5.0
- Return the service cluster associated with a hypershift cluster in ocm describe cluster
- Bump github.com/onsi/gomega from 1.26.0 to 1.27.1
- added GetLimitedSupportReasons function to allow cluster objects to access them easier
- Removed DisplayName/display_name from cluster
- network: Ensure there is no default network type
- Added name = '%s'
- Bump golang dependencies
- Upgrade linter version
- Fix linting errors
- Add no-proxy attribute to OCM-CLI
- adding an error when proxy is set for non byo-vpc cluster creation
- Add validationn when user creates a cluster onlt with no-proxy (non-interacitve mode)
- Swap flags to match usage
- Bump golang dependencies
- Fix GetCluster AMS search
- Fix edit cluster command
- Bump dependencies on ocm-sdk-go and rosa
- Add field for Management Cluster in describe cluster for hypershift clusters
- Add extra scopes support for OpenID IDP
- config: Allow using encrypted refresh tokens
- Correct the doc URLs for IDP creation
- added limited support reasons to the url_expander pkg
- better error when gcp ccs creds are not provided
- Improve existing VPC and proxy code.
- Disable color in Windows.
- Added account number to "ocm describe cluster ...".
- Show limited support flag in "ocm describe cluster ...".
- Update to SDK 0.1.240
- Only show relevant regions in interactive cluster create
- Update linter config
- Add linting GH action
- Fix linting issues
- Run go mod tidy
- Unify PR actions
- ocm-cli - Improve the cluster-wide-proxy use cases
- It should fail to create a cluster with proxy atrribute but no --use-existing-vpc
- [WIP] ocm-cli should support byovpc and cluster-wide-proxy for gcp
- It should be failed when create a non-ccs cluster with proxy attributes
- Support byovpc and cluster-wide-proxy features
- GCPNetwork attributes should show in cluster describe
- Fix HTML escaping
- It should be successful to edit a ccs cluster with proxy attribute
- Update SDK to v0.1.242
- Add STS to
describe cluster
output. - Add BYOPC flag to
describe cluster
command. - Support BYO-VPC cluster creation flags.
- Support cluster-wide proxy during cluster creation and update.
- Don't allow additional trust bundle as parameter.
- Add more URLs to expander.
- Readable error message when creating a CCS cluster with invalid
--htts-proxy
value.
This version doesn't contain changes to the functionality, only to the development and build workflows:
-
Rename
master
branch tomain
.To adapt your local repository to the new branch name run the following commands:
git branch -m master main git fetch origin git branch -u origin/main main git remote set-head origin -a
-
Automatically add changes from
CHANGES.md
to release descriptions.
- Fix binary names inside
.sha256
files - Build for all RHEL architectures
- Replace quota_summary by quota_cost
- Add alias
-p
to--parameter
The only change in this relase is that the GitHub action that publishes releases has been fixed so that it publishes correct binaries. There are no changes in functionality. See #319 for details.
-
Replace
go-bindata
with Go 1.16embed.FS
. This has no practical implication for users, but for developers it means that the project requires Go 1.16. -
Run tests using GitHub actions instead of Jenkins. This increases the platform coverate as tests now run in Linux, MacOS and Windows.
-
Color output is now generated internally without requiring the installation of the
jq
tool. -
Show provisioning error code and message.
-
Use standard XDG configuration path for
ocm.json
.If the legacy
~/.ocm.json
file already exists it continues using that, otherwise it prefers the standard XDG configuration directory. That usually means~/.config/ocm/ocm.json
.We recommend removing the old file and running the
login
command again:$ rm ~/.ocm.json $ ocm login ...
Or move the existing file to the new location:
$ mkdir -p ~/.config/ocm $ mv ~/.ocm.json ~/.config/ocm/ocm.json
-
User friendly message when offline token is no longer valid.
- Add CLI tests
- Don't remove config file on logout
- Add
pager
configuration setting - Use pager command for
list clusters
- Add table printer
- Add printer table for organizations
- Add table for plugins
- Add table for
addons
- Use table for
list idps
- Add column width learning
- Support specifying IdD Name
- feat(login): allow for empty OCM_CONFIG
- llokup clusters by subscriptions
- Update login URL for upcoming move to console.redhat.com
- Add password generation option for IDP
- Add htapssed IDP
- Update to OCM SDK 0.1.190.
- Don't require refresh token for client credentials grant.
- Don't use refresh token if have client credentials.
The only change in this release is the removal of the paging feature that was introduced in the previous release. Users have complained that it disrupts their workflows. In particular the fact that less clears the screen after finishing when the results fit in one page.
Note that in version of less included in many Linux operating systems can be
configured to disable this screen clearing adding the -F
option to the LESS
environment variable:
export LESS="-F"
But apparently other operating systems, in particular macOS, don't have this version or less, or have a version that doesn't support that option or environment variable.
This feature will be reintroduced later with a mechanism to persistently enable or disable it.
- Update ocm-sdk-go to 0.1.186
- Use
less
to page cluster list - Added ccs_only to cloud regions
- Honor machine_types ccs_only field
- ocm post: pass correct info to ApplyHeaderFlag()
- Add option to encrypt etcd during cluster installation
- list versions by channel group
- Modify resource_name comparison when populating add-ons
- Add PrivateLink To Describe Cluster
- Remove ResourceQuota Allowed field
- Merge value of
--parameter search="..."
with search query generated by thelist clusters
command.
- Update ocm-sdk-go to 0.1.173
- Commands for Job Queues
- Convert ocm account quota to ocm list quota command
- Support creating clusters in different channel groups
- Edit cluster channel group
- Adjust column padding for
list clusters
- Add flag to suppress printing of headers
- Add cluster state to
describe cluster
command - Allow autoscaling non-default machine pool with 0 replicas
- Add support for hibernate / resume cluster.
- Add flag to sshuttle.
- Fix cluster admin enabled output.
- Fix empty edit default machine pool.
- Update ocm-sdk-go to 0.1.152
- Avoid
survey.Select
bug when Default is not one of Options - Fix CheckOneOf() error message
- Drop default of --region
ocm list machinepools
- added autoscaling field, and rangeocm create cluster
- added autoscaling paramsocm describe cluster
- added autoscaling indication and rangeocm edit machinepool
- can now edit default machine pool - and autoscaling paramsocm edit cluster
- no longer able to edit compute nodes
- Show sorted version list in
ocm list versions
- Fixed API endpoint in the README file
- Support creating GCP CCS clusters
- Added taints to machine pool commands
- Machine pool labels and taints can be edited via
ocm edit machinepool
command - Added interactive option to create cluster command
- Added shell completion
- Added list
ocm list orgs
command - Updated OCM integration URL helper
instance-type
is a required parameter in create machine pool command.- Improve help and positional arg enforcement in most command.
- Show version in describe cluster command.
- Fix version check when creating a cluster.
- Add upgrade policy commands.
- Update ocm-sdk-go to 0.1.145
- Add
dry-run
parameter to create cluster command. - Add list regions comamand.
- Convert cluster versions to list versions
ocm tunnel
uses cluster id directly without a flag- Update ocm-sdk-go to 0.1.139
- Add list/create/edit/delete machine pool commands
- Show channel group in 'ocm describe cluster'.
- Add goreleaser config for homebrew-tap.
- Output sshuttle command execution string.
- new sub-command to show the plugins.
- Simplify cluster login via browser.
- Enable logging in via external_id.
- Add creator details.
- Support creating CCS clusters.
- Implement edit cluster command.
- Add token generation command.
- bump ocm-sdk-go to v0.1.131.
- Display provision shard name in describe cluster
- Add more options to create cluster command
- Add
ocm tunnel
command - Hide expiration time parameters in create cluster command
- Support git style ocm plugin
- Assume expiration is 0 when missing 'exp' claim in the jwt token.
- Add Product ID field to list/describe clusters.
- Add more env aliases to login command.
- Add delete identity provider command.
- Add delete ingress command.
- Add list addons command.
- Add edit ingress command.
- Usage is not displayed after error occurs.
- Bump ocm-sdk-go to 0.1.122.
- Add support for creating a private cluster.
- Don't fail "cluster describe" if a user is unauthorized to get account.
- cluster list, create and describe are deprecated and replaced by
list clusters
,create cluster
anddescribe cluster
. - Add support for creating identity providers.
- Add support for creating users.
- Add support for creating ingresses.
- Add support for listing identity providers.
- Add support for listing users.
- Add support for listing ingresses.
- Bump ocm-sdk-go to 0.1.112.
- Add support for expiration in ocm cluster create.
- Add support for specifying cloud provider.
- Add cloud provider to default columns.
- config: beef up help message.
- Add console URL to describe.
- Output Console URL.
- Add shell completion for resources.
- Add API Listening to cluster descrribe.
- Update to ocm-sdk-go 0.1.105
- Allow setting --managed=false in cluster list.
- Describe by name, identifier or external identifier (fixes #59).
- Support query parameters in raw HTTP methods (fixes #6).
- Add
state
to list of default columns for cluster list. - Preserve order of attributes in JSON output.
- Display quota so it supports add-ons.
- Add number of infra nodes to the output of the
cluster describe
command. - Add
--roles
flag to theaccount users
command. - Add support for
OCM_CONFIG
environment variable to indicate an alternative location of the configuration file. - Tighten output of the
account orgs
,account quota
,account users
andcluster list
commands.
- Update to SDK 0.1.78.
- Add quota resource name.
- Tighten up list output.
- Remove redundant
href
column from organization list. - Add parameter usage example.
- Add organization details to account status command.
- Add shortcuts for role bindings and resource quota.
- Add shortcuts for roles and SKUs.
- Add support for Windows.
- Add
--flavour
option toocm cluster create
.
- Allow bare
ocm login
to suggest the token page without extra noise.
- Dropped support for developers.redhat.com.
- Added
oc cluster versions
command.
- Fixed the
cluster create
command so that it retrieves all the enabled versions.
-
Added new
cluster create
command. -
Added support for
production
,staging
andintegration
as values of the--url
parameter.
- Fix quota output to look at correct API field.
- Fix
login
command so that it clears old tokens.
-
Change default version field to point to current version.
-
Add ability to open the console URL in browser.
- Don't print usage message when the
get
,post
,patch
anddelete
commands receive error responses from the server.
- Rename the tool to
ocm
.
- Fixed issue #62: the
--url
option of thelogin
command should not be mandatory.
-
Improvements in the
cluster list
command, including increasing the size of the name column. -
Added new
orgs
command to list organizations. -
Added new
account orgs
command to list organizations for the current account. -
Print roles of current user with the
account status
command. -
Add filter positional argument to the
cluster list
command.
- Added the
account
command.
- Fix deprecated issuer: should be developers.redhat.com instead of sso.redhat.com.
-
Added the
--single
option to theget
command to format the output in one single line. -
Improvements in the
cluster login
command. -
Changed the default authentication service from developers.redhat.com to sso.redhat.com. The old service will still be used when authenticating with a user name and password or with token issued by developers.redhat.com.
-
Added the
config get
andconfig set
commands to get and set configuration settings. -
Added support for shortcuts to the raw HTTP commands.
-
Added the
whoami
command. -
Added support for custom columns in the
cluster list
command.
- Added the
cluster login
command.
- Improvements in the
cluster list
andcluster describe
commands.
- Added the
completion
command that generates bash completion scripts.
- Adapt to changes in the API and SDK that moved cluster basic metrics to a new
metrics
attribute.
- Added the
cluster
command.
-
Update to use the new package names of the SDK and the CLI.
-
Build static binary.
- Send output to
stderr
only if the response HTTP code is greater than 400.
- Update to SDK 0.1.3.
- Don't pass empty tokens to connection constructor.
- Fix printing of tokens.
- Don't reorder JSON output if
jq
is available.
- Fix check of token expiration.
- Add support for login with token.
- Don't split the values of the
--parameter
command line option at commas.
- Moved from the
api-client
project into its ownuhc-cli
project.