This page will detail migration steps to upgrade your deployment of Common Fate to new versions.
Informational notice - no action required
In Common Fate v0.14 and earlier, a set of Access Providers were included in the Common Fate deployment. We refer to these as Built-In Providers.
In Common Fate v0.15+, Access Providers are now versioned and deployed separately to the Common Fate deployment, and are developed using a library called the Provider Development Kit (PDK). We refer to these as PDK Providers. Common Fate v0.15 also supports the existing Built-In Providers.
If you are currently using Built-In Providers (such as our AWS SSO or Okta Groups Access Providers), no action is currently required and your Common Fate deployment will work as-usual when updating to v0.15.
We are planning on deprecating Built-In Providers in favor of PDK Providers within the next few releases. We will publish documentation on how to migrate from Built-In Providers to PDK Providers without causing downtime in your deployment.
Rebranding From Granted Approvals to Common Fate
In v0.11.0 the platform has been rebranded to be called Common Fate, this includes renaming the repository from common-fate/granted-approvals to commonfate/common-fate. There are non breaking changes to the appearance of some colors and logos in the frontend, as well as non breaking changes to naming conventions in the backend code.
Deployment Configuration File Changes
This change affects you if you are using the default filename
granted-deployment.yml for your deployment configuration. This release introduces a breaking change here and you will be required to rename the file to
deployment.yml before you can use gdeploy to manage your deployment.
AWS SSO Access Provider IAM changes
This change impacts you if you are using the
commonfate/aws-sso@v2 Access Provider. To check whether you are using it, inspect your
granted-deployment.yml file in a text editor. You will see the Access Provider in the
ProviderConfiguration section of the configuration file. For example:
This release adds support for Organizational Unit access rules to the AWS SSO Access Provider. This feature uses a new Common Fate framework feature we have introduced called Dynamic Fields. Dynamic Fields automatically filter the available permissions that a user can select - such as selecting an account which belongs in a particular Organizational Unit.
In order to support this feature, the AWS SSO Access Provider requires some additional read-only IAM permissions. The new permissions are:
organizations:ListTagsForResource. To prevent disruption to your deployment, these new permissions should be added prior to updating your deployment to v0.9.0.
If you do not apply these changes, your end users may see a "no options" message when trying to request access to roles:
You can view the pull request which introduced these changes here.
To add the new IAM permissions, follow the guide below.
Update the SSO Access Role CloudFormation file. Open a terminal in the same folder as your
granted-deployment.yml file, and then run:
ACCESS_HANDLER_ROLE=$(gdeploy output AccessHandlerExecutionRoleARN)
cat <<EOF > granted-access-handler-sso-role.yml
- Action: sts:AssumeRole
Description: This role grants management access to AWS SSO for the Granted Access Handler.
- PolicyName: AccessHandlerSSOPolicy
- Sid: ReadSSO
- Sid: AssignSSO
Update the existing CloudFormation stack. This guide will use the AWS Console, but you can also do this with the AWS CLI. Open a console in the account that the Granted Access Handler SSO role stack was deployed to. In most cases, this will be the root account in your AWS organization. Select the CloudFormation stack and click the "Update" button. Choose the options as shown below, opting to replace the current template and to upload a template file. Upload the template file that you created in the previous step. Navigate through the rest of the wizard and apply the update.
In Common Fate v0.14 and earlier, a set of Access Providers were included in the Common Fate deployment. These are referred to as Built-In Providers.
In Common Fate v0.15+, Access Providers are versioned and deployed separately to the Common Fate deployment, and are developed using a library called the Provider Development Kit (PDK). These are referred to as PDK Providers. Common Fate v0.15 also supports the existing Built-In Providers.
If you are currently using Built-In Providers (such as AWS SSO or Okta Groups Access Providers), no action is currently required, and your Common Fate deployment will work as-usual when updating to v0.15.
It is intended for Built-In Providers to be deprecated in favor of PDK Providers within the next few releases. Documentation will be published on how to migrate from Built-In Providers to PDK Providers, without causing downtime in your deployment.