CHANGES.rst

Changes for croud

Unreleased

1.11.1 - 2024/04/11

• Update doc for clusters restart-node because it is not superuser only anymore.
• Upgrade docs build action Python version to 3.11.

1.11.0 - 2024/03/12

• Added the scheduled-jobs edit command.
• Added support for scheduling sql jobs with the scheduled-jobs commands.
• Added command croud cloud-configurations that allows superusers to manage configuration settings of CrateDB Cloud.

1.10.1 - 2024/01/11

• Import jobs can now optionally add columns to the schema if the create_table parameter is set to true.

1.10.0 - 2023/12/21

• Added support for organization secrets of type Azure.
• Added support for importing jobs from Azure Blob Storage.

1.9.0 - 2023/12/04

• Added new resource organizations credits and subcommands that allow superusers to manage credits.

1.8.0 - 2023/11/07

• Added support for listing, deleting and creating organization secrets.
• Added support in import jobs for private S3 files using organization secrets.
• Added documentation for all import jobs commands.
• Fixed import-job create from-url throwing an error despite working.
• Added support for showing import job progress.
• Added the --transformations argument for import jobs.
• Moved import and export jobs into their own section in croud docs.
• Fixed a bug preventing s3 imports from working (due to the endpoint).
• Correctly showing percent for import jobs, and not showing for export jobs.

1.7.0 - 2023/09/11

• Added support for restoring different types of data from a snapshot.

1.6.0 - 2023/08/24

• Dropped support for Python 3.7.
• Added support for deleting users.

1.5.0 - 2023/07/27

• Added option to deploy clusters without first having to create a project. This is done by specifying a --org-id and --region, at which point the project will be created on-the-fly.
• Added new resource clusters export-jobs and subcommands that allow organization admins to manage export jobs.
• Added new subcommand get for the resource organizations files that returns a single file by its ID.

1.4.0 - 2023/06/22

• Changed import jobs status to show the error message if an import fails.
• Added the URL to the import jobs list output.
• Added support for organization file-uploads.
• Added support for cluster import jobs of type file.
• Added idp to croud me.

1.3.0 - 2023/03/14

• Add organization_id field to regions list.
• Added support for data import jobs on clusters.
• Creating an import job now displays its progress.
• Added support for cancelling contract subscriptions.
• Added the suspended state to croud cluster responses.

1.2.1 - 2023/01/05

• Unfix the version of tabulate to maintain compatibility with crash. Currently not possible to install both crash and croud in the same python environment.
• Added an ability to specify the --days-ago argument to snapshots list. This fixes an issue where no snapshots could be listed if the cluster was suspended for longer than 2 days.

1.2.0 - 2022/12/21

• Added support for listing and restoring snapshots, including cloning clusters.

1.1.0 - 2022/12/12

• Added support for creating, deleting, activating and deactivating user API keys.
• Added support to list and restore cluster snapshots.

1.0.0 - 2022/12/01

• Add support to changes the backup schedule of clusters.
• Added support for Python 3.11.
• Added support for Dependabot.
• BREAKING CHANGE! Changed clusters change-product to clusters set-product and clusters change-backup-schedule to clusters set-backup-schedule. This unifies all the clusters commands to use the same wording.
• Added support for API keys.
• Made the IDP a required parameter in croud login. It would default to cognito, which is unexpected for a lot of users, and not obvious how to change it.

0.40.0 - 2022/11/18

• Include the organization id when listing subscriptions.
• Fixed the LOG_API param to correctly use booleans in Python :/
• Added a new command allowing cancelling Stripe subscriptions.

0.39.0 - 2022/11/16

• Improved help message and required arguments for cluster deployment.
• Dropped support for Python3.6.
• Added the LOG_API environment variable, which allows debugging what API calls Croud is making.

0.38.0 - 2022/10/24

• Added new subcommand subscriptions create that allows superusers to create custom subscriptions.

0.37.0 - 2022/08/19

• Added new subcommand clusters change-product that allows organizations and project admins to change the cluster product.

0.36.0 - 2022/07/27

• Updated regions create to require the org-id and removed unnecessary arguments.
• Changed the products CLI to filter out duplicates, deprecated products and products without prices.

0.35.0 - 2022/06/22

• Added new subcommand clusters set-suspended-state that allows superusers, organization admins and project admins to suspend or resume a cluster.

0.34.0 - 2022/05/10

• Fix help message for disk size argument in clusters deploy
• Updated clusters deploy to use the new cluster provisioning API. This brings back the ability for regular users to create clusters via croud.

0.33.0 - 2022/04/07

• Added autocompletions for bash/zsh/tcsh
• Added new subcommand clusters expand-storage that allows superusers and organization admins to expand the disk size of a cluster.
• Add GitHub and Google to the idp list

0.32.0 - 2022/02/17

• Added status checks to the scaling handler. This now waits until the scaling operation is complete (or fails).
• Added parameter org-id for subscriptions list, projects list, clusters list and regions list.

0.31.0 - 2021/12/29

• Added checking of upgrade status to the upgrade handler. This now waits until the upgrade is complete (or fails).
• Added support for Python 3.10.
• Added a confirmation warning to the clusters set-ip-whitelist command.
• Sanitized the default config to make it region-agnostic.

0.30.0 - 2021/10/27

• Added new subcommand clusters set-ip-whitelist that allows restricting access to clusters.

0.29.0 - 2021/09/07

• Added new subcommand clusters set-deletion-protection that allows superusers and organization admins to set the deletion protection status of a cluster.
• Added --backup-location-endpoint-url to allow custom S3 backup locations.
• Improved help message for disk size argument in clusters deploy
• Added a croud clusters set-ip-whitelist command to whitelist IP Networks.

0.28.0 - 2021/07/26

• Improved error message when deleting a region that is up or doesn't exist.
• Added support for custom backup locations for edge regions.
• Added new subcommand clusters restart-node that allows superusers to restart a single node in a cluster.

0.27.0 - 2021/06/17

• Added support for custom specs for edge clusters.
• Added a new print_raw function to simply print the output of croud.
• Added new subcommand regions generate-deployment-manifest to fetch a deployment manifest for an edge region.
• Added the command regions create that allows superusers to add new cloud and edge regions.
• Added the command regions delete that allows superusers and organization admins deleting edge regions.
• CI: Add testing on Python 3.9.

0.26.0 - 2021/03/12

• Added a loading indicator for some nicer UX.
• Added new subcommand get for the resources clusters, organizations, projects, subscriptions that returns a single item of the requested resource by its ID.
• Added the region parameter to profiles in the config file. This makes it explicit which one is being used as the recommended API endpoint is always https://console.cratedb.cloud.
• Croud will now send a custom User-Agent including the version of croud itself and the version of the Python interpreter that is running it.

0.25.0 - 2020/11/30

• Implemented support for wide tabular output format, where all fields are displayed.
• Removed the already deprecated croud consumers commands.
• Added support for choosing the identity provider for the login via the optional --idp argument.

0.24.0 - 2020/09/08

• Added the croud subscriptions list command to list available subscriptions in a user's organization.
• Deprecated the croud consumers commands deploy, list, edit and delete, as they will be removed in the future.

0.23.1 - 2020/05/06

• Fixed a bug that prevented the saving of the config when the Crate directory did not exist. The directly will now be created and access is restricted to the user themselves.
• Removed region validation to help support newer regions.

0.23.0 - 2020/04/10

• Added croud regions list command to list available regions to the user.
• Introduced configuration profiles which replace the existing configuration options env, region and output-fmt. Since the new profiles are incompatible with the existing configuration, you need to delete the existing configuration file. Run croud config --help for further information.
• Allow _any_ as value for the --region argument. This will list resources of all available regions.

0.22.0 - 2020/03/23

• Added croud projects edit command to change a specified project. At the moment, only the name of the project may be changed.
• Removed the croud monitoring command and all its subcommands.

0.21.0 - 2019/12/20

• Added support for Python 3.8

0.20.0 - 2019/11/28

• Added new croud me edit command to change your own email address.

0.19.1 - 2019/11/18

• Fixed some spelling and formatting issues in croud organizations auditlogs list command.

0.19.0 - 2019/11/15

• Added new croud organizations auditlogs list command to show all auditlogs within an organization.
• Handle client networking errors correctly by printing a sensible error message instead of a traceback.

0.18.1 - 2019/08/09

• Fix column selection in table output for croud clusters upgrade command.

0.18.0 - 2019/08/06

• Added new croud organizations edit command to edit an existing organization.
• The plan-type argument has been made optional and is only available for superusers.
• Removed the previously deprecated croud users roles add and croud users roles remove commands.

0.17.1 - 2019/08/05

• Fix bug where the org_id was deleted from the local config when deleting a organization, even though the organization was not deleted because an error occurred.

0.17.0 - 2019/07/31

• Updated croud users list to include all user roles.
• Deprecated --no-org argument to croud users list in favor of --no-roles.
• Added the croud projects users list command to list all user within a project.
• Added the croud organizations users list command to list all user within an organization.
• Added the optional --sudo argument to be able to specify when a command should be run as superuser.
• The -org-id parameter is now optional for non-superusers. Upon login, a user's organization will be retrieved and stored in the configuration file. Whenever the --org-id parameter is needed, a fallback to the default organization will be made.
• Added support for YAML output. It can be specified with the -o yaml argument.

0.16.0 - 2019/07/18

• Added the channel argument to the cluster deploy command. This argument can be used to specify the release channel of the specified CrateDB version. The channel can be either stable (default), testing or nightly. Testing and nightly deployments can only be performed by superusers.
• Show additional information about the scaling capabilities of a product in the output of the croud products list command.

0.15.2 - 2019/07/09

• Deprecated croud users roles add and croud users roles remove in favor of project and organization level commands croud organizations|projects users add|remove.
• [Reverted] Added support for specifying the user through their email address in croud users roles add and croud users roles remove.

0.15.1 - 2019/07/05

• Added support for specifying the user through their email address in croud users roles add and croud users roles remove.

0.15.0 - 2019/07/04

• The response of the projects users add command changed from displaying only a success message to displaying the data of the created user role.
• Added projects delete command to delete existing projects.
• Added organizations delete command to delete existing organizations.
• [Breaking] The organizations users add|remove commands now require the arguments --user and --org-id. Additionally the organizations users add command requires the --role argument.
• Improved printing of error messages by including the error details returned by the server.

0.14.1 - 2019/07/04

• Fixed a bug that caused commands to always use the access token from the current_context setting to be used, even though a context / environment had been passed via --env.

0.14.0 - 2019/06/06

• Added clusters upgrade command to update an existing cluster to a later version.

0.13.2 - 2019/06/04

• Made the config set command print out a help when no attributes are set.
• Removed unneeded --project-id argument from clusters scale command.
• Fixed an issue that caused empty query results to print "Success" to the console instead of an empty table.

0.13.1 - 2019/05/29

• Updated clusters delete documentation.

0.13.0 - 2019/05/28

• Added clusters delete command to delete existing clusters.
• Added clusters scale command to scale existing clusters.
• Added consumers delete command to delete existing consumers.
• Added croud products list command to list all available products in the current region.

0.12.3 - 2019/05/28

• Fixed region support in consumers edit command.

0.12.2 - 2019/05/24

• Fix client session so it stores the refreshed access token in the configuration. This prevents the server from refreshing the access token sent by the client in case it was already expired.

0.12.1 - 2019/05/22

• Removed the redundant printed error JSON from the error message, only the message is provided. When the message is not available, the full error JSON is then printed.

0.12.0 - 2019/05/21

• Updated the API calls from the deprecated v1 to v2.
• Make the config get commands respect the output format option.

0.11.1 - 2019/05/02

• Fixed API redirect and error response bug for monitoring grafana command.

0.11.0 - 2019/04/17

• Added the commands monitoring grafana that can enable and disable Grafana dashboards for a project.

0.10.0 - 2019/04/01

• Added the commands consumers deploy, consumers list and consumers edit. The deploy command deploys a new consumer, the edit command edits an existing consumer and the list command lists existing consumers.
• [Breaking] Removed the commands product deploy, consumer-sets list and consumer-sets edit.

0.9.0 - 2019/03/20

• Added clusters deploy command that allows users to deploy a new CrateDB cluster.
• Make --org-id and --no-org arguments mutually exclusive for the users list command and print an error if both arguments are provided.
• Refactored removing users from organizations commands to parse the user argument so that users can be removed via their email address or user ID.

0.8.1 - 2019/02/22

• Fixed argument description of --role to reflect the current state.
• Fixed products deploy command which led to an exception in the command line argument parsing.

0.8.0 - 2019/02/20

• Added consumer-sets edit command that allows users to edit their consumer sets.
• Added consumer-sets list command that allows users to list their consumer sets and filter them by project ID, cluster ID and product ID.
• Added projects users add command that allows users with permission to add users to projects by specifying a project ID and a user email or ID.
• Added projects users remove command that allows users with permission to remove users from projects by specifying a project ID and a user email or ID.
• Added organizations users remove command that allows organization admins to remove users from organizations that they are admins for, by specifying an organization ID, and a user email address or ID. Super users can remove users from any organization.
• Added organizations users add command that allows organization admins to add new users to organizations they are admins for, by specifying an organization ID, and a user email address or ID. Super users can add users to any organization.

0.7.0 - 2019/02/06

• Added products deploy command that allows super users to deploy new CrateDB Cloud for Azure IoT products.

0.6.0 - 2019/02/05

• Added projects create command that allows organization admins and super users to create new projects. Super users are able to create projects in all organizations, organization admins only in the organization that the user is part of.
• Added users list sub command that lists all users within organizations that a user is part of. For super users it will list all users from all organizations. Super users can also filter by organization ID, and list all users who are not part of any organization.
• Required/Optional arguments are shown separated in help
• Added eastus2 to available regions.

0.5.0 - 2019/01/22

• Fix: Delegate all occurring error messages to the console output
• Added users roles remove sub command that allows to remove a role from a user.
• Improved help output.
• Refactored assignRoleToUser to addRoleToUser

0.4.0 - 2019/01/15

• Added users roles add sub command that assigns a role to user (super users only).
• Fixed config get output-fmt command
• Added organizations list sub command that lists organizations
• Removed region arg from me command
• Added organizations create sub command that creates an organization (super users only)

0.3.0 - 2019/01/09

• SECURITY: prevented arbitrary code execution when loading the config file (ref. CVE-2017-18342)
• Fix: Login page needs to be picked according to the env set in current_context.
• Removed env subcommand (replaced with config set --env [prod|env])
• Added subcommand config get that prints out a specified default config setting
• Added subcommand config set that sets a specified default config setting

0.2.1 - 2018/12/12

• Fixed ModuleNotFoundError.

0.2.0 - 2018/12/12

• Added subcommand clusters list that prints clusters from a region, and can be filtered by project ID
• Added subcommand projects list that prints project details within a specified region (for logged in user)
• Removed name field from me subcommand
• Added env flag to commands to temporarily override auth context
• Added a subcommand env that allows you to switch env (so you can be logged into multiple environments. E.g. croud env prod

0.1.0 - 2018/11/28

• Load croud commands from a croud_commands entry points section.
• Added a tabular format to the list of possible output formats in subcommands.
• Added subcommand me that allows to print info about the current logged-in user.
• Added subcommand login that allows to login to https://cratedb.cloud using OAuth. It will open a browser to start the authentication process.
• Added a subcommand logout that clears the stored login token, and clears the OAuth session
• The environment used to logged to in is now stored in config, so it is only necessary to provide the --env flag on the login subcommand