Skip to content

Commit

Permalink
DOCS-689 Viridian Organization Documentation (#140)
Browse files Browse the repository at this point in the history
* DOCS-689 Viridian Organization Documentation

Updates to navigation, playbooks, and existing, re-used, topics as well as new files for the details

* Updated from Eugene's review

Also added information on the need to reset password before MFA can be enabled if not already set.

* Updated from review (Karthic and Andrii)

I have brought the docs into line with the current product (MFA enforcement, user limit) and rejigged the payments information to remove the separate Add Payment Method topic and merge the information into the Create Account topic.

I've also given it a good read-through, caught some interface changes, ensured any wording changes from the review are applied where applicable, and all that jazz.

* Updated from Artem's review
  • Loading branch information
rebekah-lawrence authored Jan 25, 2024
1 parent e11e649 commit 5f04960
Show file tree
Hide file tree
Showing 34 changed files with 652 additions and 149 deletions.
1 change: 1 addition & 0 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions check-links-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
26 changes: 21 additions & 5 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
24 changes: 24 additions & 0 deletions docs/modules/ROOT/pages/accept-invitation.adoc
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions docs/modules/ROOT/pages/add-users.adoc
Original file line number Diff line number Diff line change
@@ -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.
19 changes: 19 additions & 0 deletions docs/modules/ROOT/pages/change-password.adoc
Original file line number Diff line number Diff line change
@@ -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.
109 changes: 66 additions & 43 deletions docs/modules/ROOT/pages/create-account.adoc
Original file line number Diff line number Diff line change
@@ -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]
34 changes: 34 additions & 0 deletions docs/modules/ROOT/pages/create-budget-tracker.adoc
Original file line number Diff line number Diff line change
@@ -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
6 changes: 4 additions & 2 deletions docs/modules/ROOT/pages/dedicated-cluster.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down
Loading

0 comments on commit 5f04960

Please sign in to comment.