Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cloud-docs rst->md conversion #55

Merged
merged 9 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/howtos/add-users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
(add-users)=
# Add Users

This is a quick guide on how to add users to organizations and how to manage
their privileges. This information can also be found in the CrateDB Cloud
Console {ref}`Overview <console-overview>`, but is presented here separately
for ease of use.
matkuliak marked this conversation as resolved.
Show resolved Hide resolved

In CrateDB Cloud, you can add team members to your organizations. In order to
add a user, they must first have signed up for CrateDB Cloud. Once they have
an existing account, they can be added as a user. Users can be members or
admins of more than one organization at a time, but every organization must
have at least one organization admin (see also Restrictions below).

(add-users-to-org)=
## Add Users to an Organization

New users can be added to an organization by going to the Users tab in the
left-hand menu. To add and manage users of the organization, you must be the
organization admin.

````{note}
For more information on user roles and associated privileges, see the
documentation on {ref}`user roles <user-roles>`.
````
matkuliak marked this conversation as resolved.
Show resolved Hide resolved

![Cloud Console users overview](../_assets/img/users-overview.png)

matkuliak marked this conversation as resolved.
Show resolved Hide resolved
On this page, you can see an overview of all users associated with the
organization. It will show their username, email, user role, and their status.

To add a new user click the *Add user* button in the top right. Then you can
add a new user either by their email or their user ID. You can also choose
whether the user should have admin privileges.

![Cloud Console organization overview users tab](../_assets/img/add-user.png)

(add-users-edit)=
## Edit or Delete Users from an Organization

You can also edit user roles and delete users in the *Users* tab.
To edit a user's role, simply click the pen icon corresponding to
that user in the user table. This will bring up a dropdown menu.
To delete a user, use the bin icon.
matkuliak marked this conversation as resolved.
Show resolved Hide resolved

(restrictions)=
## Restrictions

An organization needs to have at least one organization admin. It is therefore
not possible to remove the organization admin if there is only one.
67 changes: 0 additions & 67 deletions docs/howtos/add-users.rst

This file was deleted.

23 changes: 0 additions & 23 deletions docs/howtos/connect-to-cluster/index.md

This file was deleted.

48 changes: 48 additions & 0 deletions docs/howtos/create-org.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
(create-org)=
# Create organization
matkuliak marked this conversation as resolved.
Show resolved Hide resolved

This is a guide on how to create a new organization in the CrateDB Cloud
Console. If you follow the [cluster deployment
tutorial](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html),
Comment on lines +5 to +6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use indirect HTTP links, or instead, use a {ref} without further ado?

your first organization will be automatically created for you. However,
there are scenarios where you may want to create a new organization.

If you arrive at the Console for the first time, or if you have deleted
your last organization, you will have to create an organization to use
the CrateDB Cloud Console\'s functionality.

If you wish to create multiple organizations when you are already member
of one, the process is slightly different. This guide will outline both
methods.

(create-org-new)=
## Create first organization

When you first access the CrateDB Cloud Console after signing up, you
will arrive at the Cluster overview page. You will also be informed,
that your first organization named \"My Organization\" has been created
for you.

![Cloud Console org overview without organization](../_assets/img/new-account-arrival.png)

(create-org-multiple)=
## Create multiple organizations

If you are already in an organization and want to create another one, go
to the Account tab. Here you will see a list of all your organizations
and your [user
role](https://crate.io/docs/cloud/reference/en/latest/user-roles.html)
in them.

![Cloud Console account tab](../_assets/img/account.png)

To create a new organization, click on *Create new organization* at the
top right above the organization list. When prompted, simply input the
name of your new organization and confirm by clicking *Create
organization*. To delete an organization, click the trashcan icon next
to the organization in the list.

To switch the active organization, click on the organization name in the
list. All organization and cluster management options displayed in the
CrateDB Cloud Console will then refer to that organization until you
switch organizations again.
61 changes: 0 additions & 61 deletions docs/howtos/create-org.rst

This file was deleted.

139 changes: 139 additions & 0 deletions docs/howtos/delete-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
(delete-cluster)=
# Delete cluster

This is a guide on how to delete a CrateDB Cloud cluster. It consists of
two parts: one describes the process of deleting a cluster created
through Microsoft Azure, the other is for a cluster created through AWS.
For Azure, there are in turn two methods: via the CrateDB Cloud Console
and through the Azure Portal. Each are outlined in the Azure section.

Although the {ref}`general documentation <console-overview>`
for the CrateDB Cloud Console explains how you can delete a cluster
specifically within the Console, this tutorial provides a step-by-step
guide for *all* methods of deleting a CrateDB Cloud cluster. This is to
make the process more transparent and easier to find and use.

````{Warning}
All cluster data will be lost on deletion. This action cannot be undone.
````

(delete-cluster-azure)=
## Microsoft Azure

If you followed the steps of the {ref}`tutorial on how to set up a cluster
from scratch via Microsoft Azure <signup-azure-to-cluster>`,
you should have a cluster running now. If you created your
CrateDB Cloud cluster via the Microsoft Azure offering, you have two
different ways to delete a cluster, once it has been created. The first
is through the CrateDB Cloud Console itself, the second is via the
Microsoft Azure SaaS listing. We will describe each process below.

(delete-cluster-az-console)=
### Deleting a cluster via the CrateDB Cloud Console

The easiest and preferred way to delete a cluster is via the CrateDB
Cloud Console. Make sure you are logged in to the Console with a user
that has admin access in the organization where your cluster is
deployed. For more on what that means, please see the documentation on
{ref}`user roles. <user-roles>`

First, you need to select the cluster in question. To do this, we need
to access the Clusters page in the left-hand sidebar. There you should
see a list of all your clusters.

![Cloud Console Clusters overview](../_assets/img/clusters-overview.png)

Simply click the \"View\" button on the one you want to delete. This
will bring you to the overview of said cluster. There will be a \"Delete
cluster\" button in the top right corner. After clicking this button,
you will be prompted to input the name of the cluster to avoid
accidental deletion of your cluster. After you submit by clicking
*Confirm*, your cluster will be deleted.

(delete-cluster-az-portal)=
### Deleting a cluster via the Microsoft Azure Portal

As an alternative option, you can also delete a cluster - once
deployment has been confirmed in the CrateDB Cloud Console - directly
via the Microsoft Azure Portal. If you followed the previous tutorial on
deploying a cluster from scratch using the Azure Marketplace, you will
already be familiar with it.

To delete a cluster via the Azure Portal, first we must head to the
[Azure Portal homepage](https://portal.azure.com/). Make sure you are
logged in with the correct account while on this page.

If all is well, you should be able to see a section titled *Azure
Services* on the landing page. If you have recently used a SaaS
resource, you should find in this overview the item \"Software as a
Service (SaaS)\". If this item is not present in the list, go to the
search bar at the top (which says *search resources, services, and
docs*) and enter \"SaaS\" there. The SaaS item should then appear in the
list of results.

![Azure Portal services menu](../_assets/img/azureservices.png)

Click on this icon. If you have subscribed to the CrateDB Cloud offer
and have deployed a cluster previously, the cluster name should now
appear in the list of SaaS items.

![Azure Portal SaaS subscriptions list](../_assets/img/azuresaas.png)

All that remains is to click directly on the relevant cluster name (you
do not need to tick the box). This will take you to a screen with
cluster details.

![Azure Portal SaaS cluster details](../_assets/img/azuresaasdetails.png)

To delete the cluster, press the *Delete* button at the top right and
confirm.

(delete-cluster-aws)=
## AWS

(delete-cluster-aws-marketplace)=
### Deleting a cluster via the AWS Marketplace

You can deploy a cluster on CrateDB Cloud via AWS by subscribing to the
offering on the [AWS
Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND). The
offer will refer you to the CrateDB Cloud wizard where you can configure
your plan and cluster. Finally, this process will lead you to the
CrateDB Cloud Console.

To delete a cluster created in this way, you must unsubscribe from the
AWS Marketplace offer. To do so, go to the AWS Marketplace website and
make sure you are logged in with the account that you used to subscribe
to the offer.

On the landing page, find your account name in the top right corner, and
in the dropdown menu, select *Your Marketplace Software*.

![AWS Marketplace landing page](../_assets/img/aws-marketplace.png)

This will take you to an overview of your AWS Marketplace subscriptions.
You should see CrateDB Cloud there. Each subscription item has a button
labeled *Manage*. Click this button for CrateDB Cloud.

![AWS Marketplace subscription management page](../_assets/img/aws-subscriptions.png)

You will now see a page with the CrateDB Cloud \"pay as you go\" offer
on it. At the top right corner there is a button labelled *Actions*.

![AWS Marketplace subscription CrateDB Cloud](../_assets/img/aws-cratedbcloud.png)

This generates a drop-down menu with various options for interacting
with the offer. In this menu, click the option *Cancel subscription*.

A warning will appear stating that canceling the subscription will not
terminate your running services. Do not worry: upon receiving a notice
of cancellation of the subscription, the CrateDB Cloud team will
terminate your running services for you. Therefore, you can safely
cancel your subscription at this prompt to delete your cluster.

(delete-cluster-billing)=
## Billing

Crate.io only bills for actual cluster usage. During cluster operation,
this is on a per-hour basis. As soon as the cluster is deleted, nothing
further will be billed for that cluster.
Loading
Loading