diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index ee59c2d..7ee28a8 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -58,6 +58,7 @@ asciidoc: idseparator: '-' hazelcast-cloud: Viridian Cloud page-cloud-console: https://viridian.hazelcast.com/ + page-cloud-signup: https://viridian.hazelcast.com/sign-up extensions: - ./lib/tabs-block.js - asciidoctor-kroki diff --git a/antora-playbook.yml b/antora-playbook.yml index ff08ffd..fea7197 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -56,6 +56,7 @@ asciidoc: idseparator: '-' hazelcast-cloud: Viridian Cloud page-cloud-console: https://viridian.hazelcast.com/ + page-cloud-signup: https://viridian.hazelcast.com/sign-up extensions: - ./lib/tabs-block.js - asciidoctor-kroki diff --git a/check-links-playbook.yml b/check-links-playbook.yml index bc532e5..4acb3a5 100644 --- a/check-links-playbook.yml +++ b/check-links-playbook.yml @@ -56,6 +56,7 @@ asciidoc: idseparator: '-' hazelcast-cloud: Viridian Cloud page-cloud-console: https://viridian.hazelcast.com/ + page-cloud-signup: https://viridian.hazelcast.com/sign-up extensions: - ./lib/tabs-block.js - asciidoctor-kroki diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index b4119aa..8c536bd 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -33,11 +33,27 @@ ** xref:download-logs.adoc[Download Logs] * xref:tools.adoc[Developer Tools] -.Manage Accounts -* xref:create-account.adoc[Create an Account] -* xref:delete-account.adoc[Delete an Account] -* xref:multi-factor-authentication.adoc[Multi-Factor Authentication] -* xref:payment-methods.adoc[Billing and Payments] +.Organizations and Accounts +* xref:organizations-and-accounts.adoc[Overview] +* xref:organization.adoc[Organizations] +** xref:create-account.adoc[Create an Account] +** xref:update-organization-name.adoc[Update Organization Name] +** xref:add-users.adoc[Add Users] +*** xref:user-roles.adoc[User Roles] +*** xref:invite-user.adoc[Invite User] +** xref:remove-user.adoc[Remove User] +** xref:delete-account.adoc[Delete Organization] +** xref:payment-methods.adoc[Billing and Payments] +*** xref:view-usage-and-bills.adoc[View Usage and Bills] +*** xref:update-payment-method.adoc[Update Payment Method] +*** xref:create-budget-tracker.adoc[Create or Edit Budget Tracker] +* xref:users.adoc[Users] +** xref:accept-invitation.adoc[Accept Invitation to Organization] +** xref:view-organization-details.adoc[View Organization Details] +** xref:view-and-update-profile.adoc[View and Update Profile] +** xref:multi-factor-authentication.adoc[Multi-Factor Authentication] +** xref:manage-api-key.adoc[Manage API Key] +** xref:change-password.adoc[Change Password] .Manage Clusters * xref:create-clusters.adoc[Create] diff --git a/docs/modules/ROOT/pages/accept-invitation.adoc b/docs/modules/ROOT/pages/accept-invitation.adoc new file mode 100644 index 0000000..95fb1f6 --- /dev/null +++ b/docs/modules/ROOT/pages/accept-invitation.adoc @@ -0,0 +1,24 @@ += Accept Invitation to Organization +:description: When the admin user invites someone to join the organization, an invitation is sent to the specified email address unless that email address already exists in {hazelcast-cloud}. + +{description} + +NOTE: The same email address cannot be used more than once in a single organization, or in more than one organization. + +To accept an invitation to join an organization, complete the following steps: + +. Open the email from your organization +. Select the *ACCEPT INVITE* button ++ +The Hazelcast {hazelcast-cloud} organization invitation screen displays + +. Enter your name in the *Full Name* text box ++ +Your email address is pre-filled and cannot be edited. This is the email address used when signing in. + +. Enter a password in the *Password* text box. This is the password used when signing in +. Select the *Create Account* button + +Your account is created, and you can sign in using the specified email and password. + +NOTE: To further secure your account, enable MFA. For further information on enabling MFA, see the xref:multi-factor-authentication.adoc[] topic. diff --git a/docs/modules/ROOT/pages/add-users.adoc b/docs/modules/ROOT/pages/add-users.adoc new file mode 100644 index 0000000..5ca8f38 --- /dev/null +++ b/docs/modules/ROOT/pages/add-users.adoc @@ -0,0 +1,12 @@ += Add Users +:description: To share resources across the organization, you must add users to the account. + +{description} + +NOTE: If you have a Trial subscription, you cannot add users to your organization. For further information on Trial subscriptions, see the xref:free-trial.adoc[{hazelcast-cloud} Trial] topic. + +When you add a user to the organization, they are assigned a user role. For further information on user roles, see the xref:user-roles.adoc[User Roles] topic. + +NOTE: Currently, there are only two user roles; the admin user, who set up the organization account, and organization users who have been added to the organization by the admin user. + +You can add a user by sending an invitation to the email address the user will use when signing in to {hazelcast-cloud}. For further information on sending an invitation, see the xref:invite-user.adoc[Invite User] topic. diff --git a/docs/modules/ROOT/pages/change-password.adoc b/docs/modules/ROOT/pages/change-password.adoc new file mode 100644 index 0000000..b3de9be --- /dev/null +++ b/docs/modules/ROOT/pages/change-password.adoc @@ -0,0 +1,19 @@ += Change Password +:description: When logging in using a username and password, Hazelcast recommends that you change your password regularly. + +{description} + +To change your password, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Password* from the *Account* options ++ +The Account Settings screen displays. + +. Enter the password that you used when signing in to the console in the *Current Password* text box +. Enter the password that you want to use when signing in next time in the *New Password* text box +. Enter the new password again in the *Confirm New Password* +. Select the *CHANGE* button ++ +Your password is updated, and a confirmation box displays to confirm the change. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/create-account.adoc b/docs/modules/ROOT/pages/create-account.adoc index ee7a81d..a6cbe5c 100644 --- a/docs/modules/ROOT/pages/create-account.adoc +++ b/docs/modules/ROOT/pages/create-account.adoc @@ -1,78 +1,101 @@ -= Creating an Account -:description: Before you can create a cluster, you must create an account. You can create an account with your GitHub credentials, Google credentials, or you can provide an email address and password. += Create an Account +:description: You must create an account before you can use {hazelcast-cloud}. Creating an account creates an organization with a single user. You can sign up using an email address and password, or with a GitHub or Google account. :toclevels: 3 {description} -== Creating a New Account +Whichever sign-up method you use, you are given the choice of creating a free Trial account, or a paid Viridian Standard account. For further information on the available {hazelcast-cloud} editions, see the xref:overview.adoc[Hazelcast {hazelcast-cloud}] section. -To create a new account, go to the link:{page-cloud-console}[{hazelcast-cloud} sign-up page, window=_blank]. +NOTE: By creating an account, you are agreeing to the {hazelcast-cloud} link:https://viridian.hazelcast.com/terms-of-service[Terms of Service,window=_blank] and the Hazelcast link:https://hazelcast.com/privacy/[Privacy Policy,window=_blank]. These documents are also available from the sign-up page. +To create an account, complete the following steps: + +. Open the link:{page-cloud-signup}[{hazelcast-cloud} sign-up page, window=_blank] + +. Enter the sign-up information for the method you prefer, as follows: ++ [tabs] ==== Email:: + -- -. Enter your name, email address, and a password. -. Click *Create Account*. +. Enter your name in the *Full Name* text box +. Enter your email address in the *Email* text box +. Enter the password you want to use when signing in in the *Password* text box +. Select the *Create Account* button + -A confirmation email will be sent to your email address. -. Click *Verify your email* in the confirmation email to confirm your account. -. Sign into your account. +A confirmation email is sent to the provided email address. + +. Select the *Verify your email* link in the confirmation email to confirm your account +. Sign into your account using the credentials you entered during sign up -- -Google:: +GitHub:: + -- -. Click *Google*. -. Select a Google account. -. Sign into Google if you haven't already. +NOTE: If you use this method, you do not create a {hazelcast-cloud} password. If you subsequently want to sign in with your email and use MFA in {hazelcast-cloud}, you must set a password first. For further information on setting a password, see the xref:change-password.adoc[] topic. + +. Select the *GitHub* button ++ +If you are not already signed in to your GitHub account, sign in now. ++ +If you have enabled MFA on your GitHub account, you must confirm your identity using your usual method. + +. Select the *Authorize Hazelcast* button -A confirmation email will be sent to your registered email address and you will be signed into the {hazelcast-cloud} console. +A confirmation email is sent to your registered email address and the {hazelcast-cloud} console displays the Cluster screen ready for you to continue. -- -GitHub:: +Google:: + -- -. Click *GitHub*. -. Sign into GitHub if you haven't already. -. Click *Authorize hazelcast*. +NOTE: If you use this method, you do not create a {hazelcast-cloud} password. If you subsequently want to sign in with your email and use MFA in {hazelcast-cloud}, you must set a password first. For further information on setting a password, see the xref:change-password.adoc[] topic. + +. Select the *Google* button +. Select the Google account you want to use, or create a Google account ++ +If you are not already signed in to your Google account, sign in now. ++ +If you have enabled MFA on your Google account, you must confirm your identity using your usual method. -A confirmation email will be sent to your registered email address and you will be signed into the {hazelcast-cloud} console. +The {hazelcast-cloud} console displays the Cluster screen ready for you to continue. -- ==== -After signing in, you can choose from the following options: +Depending on the method you chose, you might be asked for further information. This can include the following: -- Begin a free 14-day trial -- Create your own clusters on {hazelcast-cloud} Standard, which requires a xref:payment-methods.adoc[payment method]. +* Why you are using {hazelcast-cloud} +* Your role +* Your organization name +* Your location +== Add Payment Method -== Changing your Profile +Before your cluster can be created, you must add a payment method. -When you first sign into the {hazelcast-cloud} console, you are prompted to provide your company name and location. You can update these details at any time. +NOTE: Currently, card payments are the only supported payment method. -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Profile*. -. Enter your details and click *Update My Details*. +Complete the Add Payment Method form as follows: -== Changing your Password +. Enter the full name of the organization in the *Full Name / Company* text box +. Enter the first line of your address in the *Address Line 1* text box +. Optionally, add the second line of your address in the *Address Line 2 (Optional)* text box +. Enter your country in the *Country* text box +. Enter the city used in your address in the *City* text box +. Enter your post, or zip, code in the *Postal Code* text box +. Enter the long number from your payment card in the *Card Number* text number +. Enter the expiry date from your payment card in the *Expiration Date* text box +. Enter the card verification code from your card in the *CVC* text box +. Select the *ADD PAYMENT DETAILS* button to save your payment details -If you registered with an email address, you can change your account password: +NOTE: Hazelcast uses a third party to store payment details and process payments. Payment details are not stored in Hazelcast. -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Password*. -. Enter your current password and then enter and confirm a new password. -. Click *Change*. +You can add only one payment method to your account. You can xref:update-payment-method.adoc[update your payment details] at any time. -== Keeping your Account Safe - -After you set up your account, you'll want to keep it safe. Here are some recommendations: - -- *Keep private information secure:* Keep your password and any xref:developer.adoc[API keys] private. - -- *Enable multi-factor authentication:* Protect your account from anyone who may know your username and password. With xref:multi-factor-authentication.adoc[multi-factor authentication], you'll need to provide a unique code that's generated on your device as well as your username and password to sign in. +== Next Steps -- *Allow only authorized devices to access your cluster:* You can xref:ip-white-list.adoc[set up an IP whitelist] to allow only known IP addresses to access your cluster. +Follow the xref:get-started.adoc[Hello World] tutorial. -== Next Steps +Alternatively, finish setting up your organization as follows: -xref:get-started.adoc[]. +* xref:add-users.adoc[Add users] to the organization +* Set up a xref:payment-methods.adoc[payment method or budget tracker] +* Enable xref:multi-factor-authentication.adoc[MFA] diff --git a/docs/modules/ROOT/pages/create-budget-tracker.adoc b/docs/modules/ROOT/pages/create-budget-tracker.adoc new file mode 100644 index 0000000..ac20d35 --- /dev/null +++ b/docs/modules/ROOT/pages/create-budget-tracker.adoc @@ -0,0 +1,34 @@ +== Create or Edit Budget Tracker +:description: To get email and in-app notifications when your usage nears specified spending limits, you can set a budget tracker for your daily and monthly spend. + +{description} + +NOTE: The budget tracker is provided as tool to help you manage your spending, and setting a budget does not constrain your usage or your payments. If you do not stop your cluster, you will continue to be charged regardless of any specified budgets. + +To create or edit a budget tracker, complete the following steps: + +. Sign in to the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info screen displays. + +. Select the *Billing & Payments* tab ++ +The Billing & Payment screen displays. + +. Open the budget settings screen as follows: ++ +.. If you have not previously set a budget tracker, select *Create Budget Tracker* +.. If you have a single budget tracker set, either select the *Edit* (pencil) icon beside the budget summary or select *Create Budget Tracker* +.. If you have both budget trackers set, select the *Edit* (pencil) icon beside either budget summary ++ +The budget settings screen displays. + +. Set or disable a spending limit alert as follows: ++ +.. To set a daily spending limit alert, enter the limit in US dollars (USD) in the *Daily Alert* text box, then set the *ON/OFF* toggle to *ON* +.. To set a monthly spending limit alert, enter the limit in US dollars (USD) in the *Monthly Alert* text box, then set the *ON/OFF* toggle to *ON* +.. To disable the spending limit alerts, set the relevant *ON/OFF* toggle to *OFF* + +. Select the *SAVE CONFIGURATION* button to save your budget settings. Selecting the *Close* link at the bottom of the screen, or the *Cancel* link in the top right, returns you to the Billing & Payments screen without saving your budget settings diff --git a/docs/modules/ROOT/pages/dedicated-cluster.adoc b/docs/modules/ROOT/pages/dedicated-cluster.adoc index 3272651..d44dd4b 100644 --- a/docs/modules/ROOT/pages/dedicated-cluster.adoc +++ b/docs/modules/ROOT/pages/dedicated-cluster.adoc @@ -1,5 +1,5 @@ = {hazelcast-cloud} Dedicated Clusters -:description: Dedicated is a managed cloud service that allows you to maintain control over the hardware, resources, and deployment options that are available to your cluster. Dedicated means you get specific servers (cloud instances) all to yourself. You do not share infrastructure with other customers, and your clusters are not accessible via the public internet. +:description: Dedicated is a managed cloud service that allows you to maintain control over the hardware, resources, and deployment options that are available to your cluster. Dedicated means you get specific servers (cloud instances) all to yourself. You do not share infrastructure with other customers, and your clusters are not accessible over the public internet. :page-dedicated: true :cloud-tags: Get Started :cloud-title: About Dedicated @@ -8,10 +8,12 @@ {description} +When you first create an account on Hazelcast {hazelcast-cloud}, you become the adminstrator of an organization. This means that you can invite users to your organization and share resources, such as clusters. For further information on organizations, see the xref:organizations-and-accounts.adoc[Organizations and Accounts] section. + You can design a Hazelcast topology that meets your specific compliance and service design needs. - Deploy your clusters to specific regions to comply with data residency laws. -- Benefit from strict container isolation for projects that require enhanced security. {hazelcast-cloud} Dedicated is SOC 2 compliant. +- Benefit from strict container isolation for projects that require enhanced security. - Deploy clusters to specific regions as part of your organization's cloud strategy. To reduce network latency, you can deploy clusters in regions that are closest to your users' locations. - Specify the memory capacity of members in your cluster, with automatic scaling enabled by default, to provide additional capacity when required. diff --git a/docs/modules/ROOT/pages/delete-account.adoc b/docs/modules/ROOT/pages/delete-account.adoc index 080551b..e0b4848 100644 --- a/docs/modules/ROOT/pages/delete-account.adoc +++ b/docs/modules/ROOT/pages/delete-account.adoc @@ -1,36 +1,52 @@ -= Deleting an Account -:description: pass:q[If you no longer need to access your clusters, you can delete your account. To avoid additional charges while your clusters are not in use, consider xref:stop-and-resume.adoc[pausing] them instead.] -:cloud-tags: Manage Accounts -:cloud-title: Deleting an Account += Delete Organization +:description: pass:q[If you no longer need to access your clusters, you can delete your organizaton. To avoid additional charges while your clusters are not in use, consider xref:stop-and-resume.adoc[pausing] them instead.] +:cloud-tags: Organizations and Accounts +:cloud-title: Delete Organization :cloud-order: 60 :toclevels: 3 {description} +You cannot delete an organization while there are outstanding payments on the account. -[[cluster-and-data-deletion]] -== Cluster and Data Deletion +If the organization is deleted, all associated users, clusters, and resources are also deleted. If you need to keep any data, ensure that you have migrated it before deleting the organization. -Deleting an account _removes_ all the following: +NOTE: You can remove organization users from your organization at any time through the User Management screen. For further information on removing organization users, see the xref:remove-user.adoc[Remove User] topic. -- Clusters linked to the account, including any associated data, such as data structures, custom classes, backups, and configuration. -- Account and payment details. -- Billing information. +Deleting an organization removes the following: -We recommend that you copy any data or details that you might need in the future. You cannot recover any data from a deleted account. +- Clusters associated with the organization, including any data such as data structures, custom classes, backups, and configuration +- Account and payment details +- Billing information +- The admin user account +- All organization user sign ins -NOTE: You may still receive marketing communications from time to time. See our link:https://hazelcast.com/privacy/[privacy policy] for more details. +NOTE: You might continue to receive occasional marketing communications from Hazelcast. See our link:https://hazelcast.com/privacy/[privacy policy^] for more details. -[[outstanding-payments]] -== Outstanding Payments +Hazelcast recommends that you copy any data or details that you might need in the future. You cannot recover any data from a deleted account. -All outstanding payments are taken during the deletion process. For this reason, we suggest that you pause or delete all clusters before you proceed, so that you know the amount you need to pay. +To delete an organization, complete the following steps: -== Deleting your Account +. Open the link:{page-cloud-console}[Hazelcast {hazelcast-cloud} console,window=_blank]. +. Select *Account* from the side navigation bar +. Select *Password* from the *Account* options ++ +The Account Settings screen displays. -Before you start, read the <> and <> sections carefully. +. Scroll down to the *Danger Zone* section of the Account Settings screen -. Sign into the link:{page-cloud-console}[Hazelcast {hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Password*. -. Scroll down to the *Danger Zone* and click *Delete This Account*. -. Enter your email address and confirm the deletion. +. Select the *DELETE THIS ORGANIZATION* button ++ +A confirmation dialog box displays. ++ +WARNING: If you delete the organization, all users, clusters, and other resources associated with the organization are also deleted. + +. Enter the admin user's email address in the *Your email* text box +. Enter `delete my account` in the *To verify, type "delete my account" below:* text box +. Select the *DELETE THIS ORGANIZATION* button ++ +WARNING: There is no confirmation dialog box. If you select the *DELETE THIS ORGANIZATION* button the users, clusters, and cluster data associated with your account are deleted immediately. This step is irreversible. + +NOTE: If the organization has an outstanding balance, it cannot be deleted until the balance is cleared. Payment is attempted using the provided payment method, if successful, the organization is deleted. For further information on billing and payments, see the xref:payment-methods.adoc[Billing and Payments] section. + +When you delete your account, no further charges are incurred and you cannot access your account. diff --git a/docs/modules/ROOT/pages/developer.adoc b/docs/modules/ROOT/pages/developer.adoc index 9c1004b..57812d6 100644 --- a/docs/modules/ROOT/pages/developer.adoc +++ b/docs/modules/ROOT/pages/developer.adoc @@ -6,22 +6,8 @@ {description} -== Using the {hazelcast-cloud} Console +include::partial$create-api-key.adoc[] -// tag::create[] -To create a new set of API credentials, do the following: +include::partial$copy-api-key.adoc[] -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Developer*. -. Click *Generate New API Key*. -// end::create[] - -You can use these credentials in your applications to manage all clusters in your account. Currently, you can only create one API key and secret pair on your account. - -IMPORTANT: Keep your keys and secrets secure. Anyone who has these credentials can delete your clusters. - -== Deleting an API Key - -You can delete your API key at any time by clicking the *Delete API Key* button. - -WARNING: After you delete your API key, any application that uses this key will no longer work unless you configure them with a new set of credentials. +include::partial$delete-api-key.adoc[] diff --git a/docs/modules/ROOT/pages/invite-user.adoc b/docs/modules/ROOT/pages/invite-user.adoc new file mode 100644 index 0000000..e5f4cfe --- /dev/null +++ b/docs/modules/ROOT/pages/invite-user.adoc @@ -0,0 +1,49 @@ += Invite User +:description: You can invite users to the account by sending an invitation to the email address they will use to sign in. + +{description} + +[NOTE] +==== +If the user you want to add to the organization is already using the same email for a different organization account, you cannot invite them to your organization until they are removed from their existing account. + +To transfer a user, they must be removed from their current organization. This can only be done by a Hazelcast {hazelcast-cloud} Administrator, or the admin user of the organization to which they are currently associated. + +When the user is removed from their existing organization, their {hazelcast-cloud} account is also deleted. + +Once their existing account has been removed, you can invite them to your organization account as described below. +==== + +To invite a user, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info screen displays. + +. Select the *User Management* tab ++ +The User Management screen displays. + +. Select the *INVITE A USER* button ++ +The Invite users dialog displays. + +. Enter the email address that the user will use to sign in to {hazelcast-cloud} in the *Email address* text box + +. Select the *Add* (plus) button to add the email address to the invitation list ++ +The added email address is listed below the text box. ++ +If you made a mistake when entering the email address, you can select the *Delete* (cross) button beside the email address. This removes the email address, and you can repeat steps 6 and 7 to add the correct email address. + +. If required, add further users by repeating steps 6 and 7 above until all email addresses to which you want to send an invitation are listed below the text box + +. Select the *INVITE* button to send an invitation to all listed email addresses. If you select the *Cancel* button, the dialog box closes without sending any invitations ++ +NOTE: If the email address already exists in {hazelcast-cloud}, no invitation is sent. + +The users must now accept the invitation before they are added to the account. For further information on accepting an invitation, see the xref:accept-invitation.adoc[Accept Invitation to Organization] topic. + +You can track the status of your invitations in the User Management screen. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/manage-api-key.adoc b/docs/modules/ROOT/pages/manage-api-key.adoc new file mode 100644 index 0000000..5864d8f --- /dev/null +++ b/docs/modules/ROOT/pages/manage-api-key.adoc @@ -0,0 +1,12 @@ += Manage Your API Key +:description: Your API key provides the credentials needed to authenticate clients to your account. + +{description} + +When you generate your API key, copy it directly from the Hazelcast {hazelcast-cloud} console. + +include::partial$create-api-key.adoc[] + +include::partial$copy-api-key.adoc[] + +include::partial$delete-api-key.adoc[] diff --git a/docs/modules/ROOT/pages/multi-factor-authentication.adoc b/docs/modules/ROOT/pages/multi-factor-authentication.adoc index ce79429..0fbd109 100644 --- a/docs/modules/ROOT/pages/multi-factor-authentication.adoc +++ b/docs/modules/ROOT/pages/multi-factor-authentication.adoc @@ -1,31 +1,54 @@ = Multi-Factor Authentication -:description: Multi-factor authentication (MFA) makes your account more secure by adding an extra step to the sign-in process. Instead of just entering a password, MFA allows you to use a trusted device to generate a secure digital pin for authentication. +:description: Multi-factor authentication (MFA) adds another layer of security to your account. If enabled, instead of relying only on a username and password, MFA uses a trusted device to generate a secure digital identifier used to confirm your identity. By default, MFA is disabled. :page-aliases: account-security.adoc :cloud-tags: Manage Accounts :cloud-order: 30 {description} -== Enabling Multi-Factor Authentication +NOTE: If signing in with Google or GitHub, set MFA for those accounts and not for your {hazelcast-cloud} account. If you use social sign-in, MFA is not requested in the {hazelcast-cloud} console, even when enabled, as your username and password credentials have not been provided. -. Install an authenticator app such as Google Authenticator on your device. -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Security*. -. Open your authenticator app and scan the QR code that is displayed in the {hazelcast-cloud} console. -. Enter the six digit verification code into the input box in the {hazelcast-cloud} console and click *Enable MFA*. -. Sign out and try signing in again. +[[enable]] +== Enable Multi-Factor Authentication -After entering your username and password, you will be asked to enter the verification code, using the authenticator app. +If you have not set a password, you must do this before you can enable MFA. To set a password, complete the following steps: -Verification codes are specific to a particular device and cannot be transferred. If you switch to a new phone, you will need to <> before you do so, then re-enable it with your new phone. +. Select *Account* from the side navigation bar +. Select *Password* from the *Account* options ++ +The Account Settings screen displays. + +. Select the *RESET* button ++ +An email is sent to the registered email address. + +. Select the *RESET YOUR PASSWORD* link provided in the email ++ +The {hazelcast-cloud} Reset Password screen displays. + +. Enter the password you want to use in the *New Password* text box +. Enter the same password in the *Confirm Password* text box +. Select the *Reset Password* button + +You must log back in to {hazelcast-cloud} using this password before you can continue. + +To enable MFA, complete the following steps: + +include::partial$mfa-enable.adoc[] ++ +You must now enter a username and password, and then provide the verification code using the authenticator app each time you sign in. + +. Sign out of the Hazelcast {hazelcast-cloud} console +. Sign in to your account using your username and password +. Use your authenticator app to complete your sign in + +include::partial$mfa-change-device.adoc[] [[disable]] -== Disabling Multi-Factor Authentication +== Disable Multi-Factor Authentication -If you've enabled MFA, you can disable it so that you can sign in without an authenticator app. +If you've enabled MFA, you can disable it at any time to sign in without an extra authentication step. -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Security*. -. Click *Disable*. +To disable MFA, complete the following steps: -You'll receive an email to confirm that MFA is disabled. +include::partial$mfa-disable.adoc[] diff --git a/docs/modules/ROOT/pages/organization.adoc b/docs/modules/ROOT/pages/organization.adoc new file mode 100644 index 0000000..8fda728 --- /dev/null +++ b/docs/modules/ROOT/pages/organization.adoc @@ -0,0 +1,15 @@ += Organization +:description: When you create a {hazelcast-cloud} account, an organization is created. This organization has a single administrator who has the same set of permissions that are granted to organization users, plus access to organization-level settings such as user management and payments. All resource-related information belongs to the organization. +:toclevels: 3 + +{description} + +The admin user manages the following: + +* Account creation. You need an account to use {hazelcast-cloud}. On creation of an account, an organization is created. For further information on creating an account, see the xref:create-account.adoc[Create Account] section +* The name of the organization. You enter an organization name during account creation, but this can be changed at any time. For further information on changing the organization name, see the xref:update-organization-name.adoc[Update Organization Name] topic +* Organization users. You can invite users to join your organization, or remove them from the organization. For further information on adding organization users and the available user roles, see the xref:add-users.adoc[Add Users] section. For further information on removing users, see the xref:remove-user.adoc[Remove User] topic +* Account deletion. Deleting the account removes the organization, and all assoicated resources and users. For further information on deleting the organization, see the xref:delete-account.adoc[Delete an Account] topic +* Billing and payments. You can view your organization usage and bills, update your payment method, and create spending alerts to help manage your budget. For further information on billing and payments, see the xref:payment-methods.adoc[Billing and Payments] section + +For further information on the additional options, which are available to all users, see the xref:users.adoc[Users] section. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/organizations-and-accounts.adoc b/docs/modules/ROOT/pages/organizations-and-accounts.adoc new file mode 100644 index 0000000..005d43e --- /dev/null +++ b/docs/modules/ROOT/pages/organizations-and-accounts.adoc @@ -0,0 +1,28 @@ += Overview +:description: An Organization account allows one or more users to use shared resources, such as clusters. Every account is owned by an organization and is controlled by an admin user. Users can belong to a single organization only. +:toclevels: 3 + +{description} + +This helps you with the following: + +* Cluster management across multiple organization users +* Multiple departments managed under a single account +* Budgeting through unified billing +* User access management + +NOTE: In addition to their administrative permissions, admin users have the same set of permissions that are granted to organization users; for example, the admin user can manage their own clusters. For further information on user permissions, see the xref:user-roles.adoc[User Roles] topic. + +For further information on organization accounts and the user roles, see the xref:organization.adoc[Organization] section. + +For further information on organization users, see the xref:users.adoc[User] section. + +== Keep your Account Safe + +To keep your account safe, Hazelcast recommends taking the following actions: + +* *Secure your private information:* Keep your password and any API key private. For further information on changing your password, see the xref:change-password.adoc[Change Password] topic. For further information on generating and deleting an API key, see the xref:manage-api-key.adoc[Manage API Key] topic + +* *Enable multi-factor authentication (MFA):* Protect your account from anyone who might know your username and password with an extra authentication step. This means that you must provide a unique code, which is generated by your authentication tool, as well as entering your username and password. MFA is also an effective defence against brute force attacks. For further information on enabling MFA, see the xref:multi-factor-authentication.adoc[Multi-factor Authentication] topic + +* *Allow only authorized devices to access your cluster:* You can set up an IP whitelist to allow only known IP addresses to access your cluster. For further information on setting up an IP whitelist, see the xref:ip-white-list.adoc[IP Whitelisting] topic diff --git a/docs/modules/ROOT/pages/overview.adoc b/docs/modules/ROOT/pages/overview.adoc index 2e6d218..d7218a8 100644 --- a/docs/modules/ROOT/pages/overview.adoc +++ b/docs/modules/ROOT/pages/overview.adoc @@ -35,6 +35,8 @@ xref:free-trial.adoc[{hazelcast-cloud} Trial] offers the capabilities of {hazelc |To maximize security whilst minimizing latency, {hazelcast-cloud} Dedicated clusters expose only private Hazelcast endpoints. For consistent performance and throughput, {hazelcast-cloud} Dedicated clusters do not share infrastructure with any other customers. |=== +NOTE: When you first create an account on Hazelcast {hazelcast-cloud}, you become the administrator of an organization. For Trial Edition users, this has no further impact. For Standard and Dedicated Edition users, this means that you can invite users to your organization and share resources, such as clusters. For further information on organizations, see the xref:organizations-and-accounts.adoc[Organizations and Accounts] section. + == Getting Started If you are a first-time user of Hazelcast {hazelcast-cloud}, see xref:get-started.adoc[]. diff --git a/docs/modules/ROOT/pages/payment-methods.adoc b/docs/modules/ROOT/pages/payment-methods.adoc index 0b9faf1..d7f499c 100644 --- a/docs/modules/ROOT/pages/payment-methods.adoc +++ b/docs/modules/ROOT/pages/payment-methods.adoc @@ -1,52 +1,21 @@ = Billing and Payments -:description: When you sign up for a {hazelcast-cloud} account, you need to add a payment card to pay for usage as well as to view how much you've spent. -:cloud-tags: Manage Accounts | Manage Accounts | Manage Accounts -:cloud-title: Payments and Billing | Add Payment Card | View Bills -:cloud-order: 33 | 34 | 35 -:cloud-anchor: | adding-a-payment-card | viewing-bills -:page-aliases: set-budget.adoc +:description: When you sign up for the Standard or Dedicated Edition of {hazelcast-cloud}, you must provide a payment method. You can view a summary of your invoices and usage at any time. +:cloud-tags: Manage Organizations +:cloud-title: Billing and Payments +:cloud-order: 33 {description} -For xref:serverless-cluster.adoc[{hazelcast-cloud} Standard clusters], you must provide a payment card to create new clusters. +When you sign up for a Standard or Dedicated {hazelcast-cloud} account, you must add a payment method as follows: -For xref:dedicated-cluster.adoc[{hazelcast-cloud} Dedicated clusters], a wider range of payment options is available, including: +* For xref:serverless-cluster.adoc[{hazelcast-cloud} Standard clusters], you are prompted to add your payment details after choosing to create a Development or Production cluster during sign-up. You must provide a payment card to create clusters. For further information on adding a payment method, see the xref:create-account.adoc#add-payment[Add Payment Method] section of the Create an Account topic +* For xref:dedicated-cluster.adoc[{hazelcast-cloud} Dedicated clusters], contact us to discuss your requirement and costs; the payment method is set up as part of this process. Alternatively, you can buy a three-member (13.5GB of storage) package directly from the link:https://aws.amazon.com/marketplace/pp/prodview-olxywxtjninay[AWS Marketplace^] Payment options include the following: ++ +** Card payments +** Purchase orders -- Card payments -- Purchase orders -- Buying the service link:https://aws.amazon.com/marketplace/pp/prodview-olxywxtjninay[direct from AWS Marketplace]. +Once your account and payment method is set up, you can do the following: -== Adding a Payment Card - -To set up automatic payments for your usage, add a payment card to your account. For {hazelcast-cloud} Standard clusters, you are prompted to add your payment details after signing in for the first time. - -NOTE: Hazelcast uses a third party to store payment details and process payments. Payment details are not stored in Hazelcast. - -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Billing & Payments*. -. Click *Add Payment Method*. -. Complete the form by filling in your payment details. - -You can add only one payment card to your account. To change the payment card, update it. - -== Updating a Payment Card - -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Billing & Payments*. -. Click *Update Payment Method*. -. Complete the form by filling in your payment details. - -Your updated card is charged for future payments. - -== Removing a Card from your Account - -You cannot remove payment cards from your account, using the {hazelcast-cloud} console. - -To remove a payment card from your account, contact us at mailto:support@hazelcast.com[]. - -== Viewing Bills - -You can see how much you've spent in the current month as well as how much you spent in previous months. - -. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. -. Go to *Account* > *Billing & Payments*. +* View your usage and associated costs, along with your payment history, as described in the xref:view-usage-and-bills.adoc[View Usage and Bills] topic +* Update your payment method, as described in the xref:update-payment-method.adoc[Update Payment Method] topic +* Create a budget tracker, as described in the xref:create-budget-tracker.adoc[Create or Edit Budget Tracker] topic \ No newline at end of file diff --git a/docs/modules/ROOT/pages/remove-user.adoc b/docs/modules/ROOT/pages/remove-user.adoc new file mode 100644 index 0000000..43eb257 --- /dev/null +++ b/docs/modules/ROOT/pages/remove-user.adoc @@ -0,0 +1,26 @@ += Remove User +:description: You can remove organization users from your account at any time through the User Management screen. + +{description} + +NOTE: You cannot remove the admin user in this way. For further information on removing the admin user, see the xref:delete-account.adoc[Delete Organization] topic. + +To remove an organization user, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info screen displays. + +. Select the *User Management* tab ++ +The User Management screen displays. + +. Select *Remove* from the end of the row for the organization user you want to delete ++ +The remove user confirmation dialog displays. + +. Select the *Yes* button to remove the organization user from the organization and delete their account. Selecting the *No* button closes the dialog box without deleting the user + +NOTE: Removing an organization user does not delete any clusters or resources that have been created or updated using their account. When the organization user is removed, the admin user inherits ownership of the relevant clusters and resources. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/serverless-cluster.adoc b/docs/modules/ROOT/pages/serverless-cluster.adoc index 4486f21..dbe4b10 100644 --- a/docs/modules/ROOT/pages/serverless-cluster.adoc +++ b/docs/modules/ROOT/pages/serverless-cluster.adoc @@ -10,6 +10,8 @@ Standard means that Hazelcast manages the cloud infrastructure for you. Each {hazelcast-cloud} Standard cluster is an independent deployment of Hazelcast Platform in a Kubernetes container. This design guarantees resource isolation, prevents resource stealing, and provides isolated network access. +When you first create an account on Hazelcast {hazelcast-cloud}, you become the administrator of an organization. This means that you can invite users to your organization and share resources, such as clusters. For further information on organizations, see the xref:organizations-and-accounts.adoc[Organizations and Accounts] section. + == {hazelcast-cloud} Standard Cluster Types // tag::types[] diff --git a/docs/modules/ROOT/pages/update-organization-name.adoc b/docs/modules/ROOT/pages/update-organization-name.adoc new file mode 100644 index 0000000..4259067 --- /dev/null +++ b/docs/modules/ROOT/pages/update-organization-name.adoc @@ -0,0 +1,24 @@ += Update Organization Name +:description: When you created an account, an organization was created. You provided a name for the organization when you created the account. The organization details can be viewed, and the name updated, at any time. +:toclevels: 3 + +{description} + +To update the organization name, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info page displays. ++ +The organization details are as follows: ++ +* *Organization ID*. This is used to identify your account, and cannot be changed +* *Organization name*. This is the name you provided for your organization, and can be updated at any time +* *Date created*. This is the date on which you created your account in the format YYYYY - MM - DD, and cannot be changed. For example, if your account was created on the 4th of May 2022, the displayed date would be 2023 - 05 - 04 + +. Select the *Edit* (pencil) icon beside the current organization name in the *Edit organization name* box + +. Update the name as required +. Select the *Confirm* (check mark) button to save your changes \ No newline at end of file diff --git a/docs/modules/ROOT/pages/update-payment-method.adoc b/docs/modules/ROOT/pages/update-payment-method.adoc new file mode 100644 index 0000000..03acae6 --- /dev/null +++ b/docs/modules/ROOT/pages/update-payment-method.adoc @@ -0,0 +1,30 @@ +== Update Payment Method +:description: You can change your payment details at any time. + +{description} + +NOTE: A payment method is not required for {hazelcast-cloud} Trial Edition. + +To update your payment details, complete the following steps: + +. Sign in to the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info screen displays. + +. Select the *Billing & Payments* tab ++ +The Billing & Payment screen displays. + +. Select *Update Payment Method* ++ +The Update Payment Method screen displays. ++ +NOTE: Currently, card payments are the only supported payment method. + +. Complete the Update Payment Method form as required. For further information on the fields, see the xref:create-account.adoc[Add Payment Method] section of the Create an Account topic + +. Select the *UPDATE PAYMENT DETAILS* button to save the changes to your payment details. Selecting the *Cancel* button returns you to the Billing & Payments screen without saving your changes + +NOTE: Hazelcast uses a third party to store payment details and process payments. Payment details are not stored in Hazelcast. diff --git a/docs/modules/ROOT/pages/user-roles.adoc b/docs/modules/ROOT/pages/user-roles.adoc new file mode 100644 index 0000000..9456bbd --- /dev/null +++ b/docs/modules/ROOT/pages/user-roles.adoc @@ -0,0 +1,37 @@ += User Roles +:description: Each user has a role assigned to them. The role defines the permissions granted to that user. + +{description} + +The current user roles are as follows: + +* Admin user. This is the user who set up the organization account +* Organization user. This is any user who has been added to the organization by the admin user + +All users have the following permissions: + +* Manage their own clusters. This allows users to work with Hazelcast, for example to: ++ +** xref:create-clusters.adoc[Create clusters] +** xref:stop-and-resume.adoc#pausing-a-cluster[Pause clusters] +** xref:stop-and-resume.adoc#resuming-a-cluster[Resume clusters] +** xref:deleting-a-cluster.adoc[Delete clusters] +** xref:backup-and-restore.adoc[Create backups] +** xref:custom-classes-upload.adoc#package[Upload custom classes] +** xref:data-structures.adoc[Configure data structures] + +* https://docs.hazelcast.com/management-center/5.3/getting-started/overview[Use Management Center^] +* xref:view-organization-details.adoc[View the organization name] +* xref:view-and-update-profile.adoc[View and update their own profile] +* xref:multi-factor-authentication.adoc[Enable and disable Multi-factor Authentication] + +In addition, admin users have the following permissions: + +* xref:invite-user.adoc[Invite user] +* xref:remove-user.adoc[Delete user] +* xref:payment-methods.adoc[Manage billing and payments] +* xref:delete-account.adoc[Delete the organization account] + +Admin users can see all clusters. If an organization user is removed, the admin user inherits ownership of the related clusters and resources. + +When updates are made, for example to the state of a cluster or to an organization user's name, there might be a delay between the change being made and the view presented to the admin user. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/users.adoc b/docs/modules/ROOT/pages/users.adoc new file mode 100644 index 0000000..f92e61c --- /dev/null +++ b/docs/modules/ROOT/pages/users.adoc @@ -0,0 +1,17 @@ += Users +:description: Whether you are an admin user or an organization user, you can access specific settings to support your use of Hazelcast {hazelcast-cloud}, including managing your profile and API key. Organization users must accept an invition to join the organization account before they can access the {hazelcast-cloud} console. +:toclevels: 3 + +{description} + +Organization users cannot accept an invitation to join an organization account if they are associated with a different organization using the same email address. For further information on accepting an invitation, see the xref:accept-invitation.adoc[Accept Invitation to Organization] section. + +All users can do the following: + +* View the name of their associated organization. For further information on viewing the organization name, see the xref:view-organization-details.adoc[View Organization Details] topic +* View and update their profile. For further information on updating your profile, see the xref:view-and-update-profile.adoc[View and Update Profile] topic +* Enable and disable MFA on their account. For further information on enabling and disabling MFA for your sign in, see the xref:multi-factor-authentication.adoc[] topic +* Generate, copy, and delete an API key. For further information on the API key, see the xref:manage-api-key.adoc[Manage API Key] topic +* Change the password used to sign in to their account. For further information on changing the password associated with your sign in, see the xref:change-password.adoc[Change Password] topic + +For further information on the additional options, which are available to admin users only, see the xref:organization.adoc[Organizations] section. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/view-and-update-profile.adoc b/docs/modules/ROOT/pages/view-and-update-profile.adoc new file mode 100644 index 0000000..a3be589 --- /dev/null +++ b/docs/modules/ROOT/pages/view-and-update-profile.adoc @@ -0,0 +1,19 @@ += View and Update Profile +:description: Every user has a profile, which they can view and update at any time. + +{description} + +To view your profile, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Profile* from the *Account* options ++ +The Profile screen displays. + +You can update your profile information as follows: + +* To change the name, update the *Full Name* text box +* To change your location, select the new location from the *Location* drop-down menu + +When you have made the changes you require, select the *UPDATE MY DETAILS* button. diff --git a/docs/modules/ROOT/pages/view-organization-details.adoc b/docs/modules/ROOT/pages/view-organization-details.adoc new file mode 100644 index 0000000..f1c8b3b --- /dev/null +++ b/docs/modules/ROOT/pages/view-organization-details.adoc @@ -0,0 +1,14 @@ += View Organization Details +:description: Organization users can view the name of the organization with which their sign in is associated. They cannot change the name. + +{description} + +NOTE: If you want to change the name of the organization, this must be done by the admin user. For further information on changing the name of the organization, see the xref:update-organization-name.adoc[Update Organization Name] topic. + +To view the organization name, complete the following steps: + +. Open the link:{page-cloud-console}[{hazelcast-cloud} console, window=_blank] +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The organization name displays. diff --git a/docs/modules/ROOT/pages/view-usage-and-bills.adoc b/docs/modules/ROOT/pages/view-usage-and-bills.adoc new file mode 100644 index 0000000..171fec7 --- /dev/null +++ b/docs/modules/ROOT/pages/view-usage-and-bills.adoc @@ -0,0 +1,20 @@ +== View Billing and Payment Summary +:description: See how much you've spent in the current month and how much you spent in previous months. + +{description} + +To view your spending information, complete the following steps: + +. Sign in to the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]. +. Select *Account* from the side navigation bar +. Select *Organization* from the *Account* options ++ +The Info screen displays. + +. Select the *Billing & Payments* tab ++ +The Billing & Payment screen displays. + +On this screen, You can view how much you've spent, your invoice history, and payment method at any time. + +You can also xref:update-payment-method.adoc[update your payment method] and xref:create-budget-tracker.adoc[create or edit a budget tracker]. \ No newline at end of file diff --git a/docs/modules/ROOT/partials/copy-api-key.adoc b/docs/modules/ROOT/partials/copy-api-key.adoc new file mode 100644 index 0000000..40fbc9e --- /dev/null +++ b/docs/modules/ROOT/partials/copy-api-key.adoc @@ -0,0 +1,15 @@ +== Copy API Key + +To copy your API key, do the following: + +. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank] +. Select *Account* from the side navigation bar +. Select *Developer* from the *Account* options ++ +The Developer screen displays. + +. Select the *Copy* (overlapping squares) button ++ +TIP: Copy it now and store it somewhere safe, as the secret is not shown again after you leave this screen. Next time this screen displays, you can view only the API key. + +The API key is copied to your clipboard. You can now paste the API key into your application configuration. diff --git a/docs/modules/ROOT/partials/create-api-key.adoc b/docs/modules/ROOT/partials/create-api-key.adoc new file mode 100644 index 0000000..a64a309 --- /dev/null +++ b/docs/modules/ROOT/partials/create-api-key.adoc @@ -0,0 +1,21 @@ +== Create an API Key + +// tag::create[] +NOTE: You can create only one API key and secret pair on your account. If you need to change your API credentials, you must first remove your existing credentials, and then create new credentials. + +To create a set of API credentials, do the following: + +. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank] +. Select *Account* from the side navigation bar +. Select *Developer* from the *Account* options ++ +The Developer screen displays. + +. Select the *Generate New API Key* button + +Use these credentials in your applications to manage all clusters in your account. + +After creating your credentials, ensure that you applications are correctly configured to use the API credentials. +// end::create[] + +IMPORTANT: Keep your keys and secrets secure. Anyone who has these credentials has full access to your clusters. diff --git a/docs/modules/ROOT/partials/delete-api-key.adoc b/docs/modules/ROOT/partials/delete-api-key.adoc new file mode 100644 index 0000000..5023211 --- /dev/null +++ b/docs/modules/ROOT/partials/delete-api-key.adoc @@ -0,0 +1,19 @@ +== Delete an API Key + +WARNING: If you delete your API key, any application using the key will not work unless you update the configuration with a new set of credentials. + +To create a set of API credentials, do the following: + +. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank] +. Select *Account* from the side navigation bar +. Select *Developer* from the *Account* options ++ +The Developer screen displays. + +. Select the *Delete API Key* button ++ +A confirmation dialog box displays. + +. Select the *OK* button to delete your API key. Selecting the *Cancel* button returns you to the Developer screen without deleting your API key + +If you want to continue using your applications with Hazelcast {hazelcast-cloud}, you must create an API key again and ensure that your applications are correctly configured to use the updated API credentials. diff --git a/docs/modules/ROOT/partials/mfa-change-device.adoc b/docs/modules/ROOT/partials/mfa-change-device.adoc new file mode 100644 index 0000000..2c842fb --- /dev/null +++ b/docs/modules/ROOT/partials/mfa-change-device.adoc @@ -0,0 +1,10 @@ +=== Change Authenticator Device + +Verification codes are specific to a particular device and cannot be transferred. If you use a different device, you cannot use the codes even if they are generated from the same authentication app. + +To change the device used by your authentication app, complete the following steps: + +. <> on your old device +. <> on your new device + +You can now use your authenticator app on your new device. \ No newline at end of file diff --git a/docs/modules/ROOT/partials/mfa-disable.adoc b/docs/modules/ROOT/partials/mfa-disable.adoc new file mode 100644 index 0000000..0a240e1 --- /dev/null +++ b/docs/modules/ROOT/partials/mfa-disable.adoc @@ -0,0 +1,6 @@ +. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank] +. Select *Account* from the side navigation bar +. Select *Security* from the *Account* options +. Select the *Disable* button + +A confirmation email is sent to the registered email address to confirm that MFA has been disabled. \ No newline at end of file diff --git a/docs/modules/ROOT/partials/mfa-enable.adoc b/docs/modules/ROOT/partials/mfa-enable.adoc new file mode 100644 index 0000000..1a0715d --- /dev/null +++ b/docs/modules/ROOT/partials/mfa-enable.adoc @@ -0,0 +1,10 @@ +. Install an authenticator app, such as Google Authenticator, on your device +. Sign into the link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank] +. Select *Account* from the side navigation bar +. Select *Security* from the *Account* options ++ +The Account Settings screen displays. + +. Open the authenticator app on your device, and scan the QR code that is displayed in the {hazelcast-cloud} console +. Enter the six-digit verification code provided by the authenticator app in the {hazelcast-cloud} console +. Select the *Enable MFA* button \ No newline at end of file