Skip to content

Commit db9122d

Browse files
committed
Fix links to removed pages.
1 parent 87f4b78 commit db9122d

File tree

9 files changed

+87
-309
lines changed

9 files changed

+87
-309
lines changed

docs/howtos/create-org.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
# Create Organization
33

44
This is a guide on how to create a new organization in the CrateDB Cloud
5-
Console. If you follow the [cluster deployment
6-
tutorial](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html),
7-
your first organization will be automatically created for you. However,
8-
there are scenarios where you may want to create a new organization.
5+
Console. When you first signup in [CrateDB Cloud], your first organization will
6+
be automatically created for you. However, there are scenarios where you may
7+
want to create a new organization.
98

109
If you arrive at the Console for the first time, or if you have deleted
1110
your last organization, you will have to create an organization to use
@@ -16,7 +15,7 @@ of one, the process is slightly different. This guide will outline both
1615
methods.
1716

1817
(create-org-new)=
19-
## Create first organization
18+
## Create first organization
2019

2120
When you first access the CrateDB Cloud Console after signing up, you
2221
will arrive at the Cluster overview page. You will also be informed,
@@ -26,7 +25,7 @@ for you.
2625
![Cloud Console org overview without organization](../_assets/img/new-account-arrival.png)
2726

2827
(create-org-multiple)=
29-
## Create multiple organizations
28+
## Create multiple organizations
3029

3130
If you are already in an organization and want to create another one, go
3231
to the Account tab. Here you will see a list of all your organizations
@@ -51,3 +50,5 @@ To switch the active organization, click on the organization name in the
5150
list. All organization and cluster management options displayed in the
5251
CrateDB Cloud Console will then refer to that organization until you
5352
switch organizations again.
53+
54+
[CrateDB Cloud]: https://console.cratedb.cloud/

docs/howtos/suspend-cluster.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
This guide will provide a quick overview of how to suspend your cluster
55
using the CrateDB Cloud Console. For the purposes of this guide, it is
66
assumed that you have a cluster up and running and can access the
7-
Console. If not, please refer to the tutorial on how
8-
to {ref}`deploy a cluster for the first time. <deploy-cluster>`
7+
Console.
98

109
(what-is-suspension)=
1110
## What is cluster suspension
@@ -18,7 +17,7 @@ The benefit here is that while the cluster is suspended, you are only
1817
charged for the storage.
1918

2019
(cluster-suspend-steps)=
21-
## Steps to suspending the cluster
20+
## Steps to suspending the cluster
2221

2322
To suspend your cluster, navigate to the Clusters page in the left-hand
2423
menu. Here you can see a list of all your clusters. Click *View* on the
@@ -34,20 +33,20 @@ Once here, you can suspend your cluster. Simply click the *Suspend
3433
cluster* in the top-right.
3534

3635
(how-to-resume-a-cluster)=
37-
## Resume a cluster
36+
## Resume a cluster
3837

3938
To resume your cluster, simply click the *Resume cluster* button in the
4039
top-right while in the Overview page of your cluster.
4140

4241
![Cloud Console resume cluster](../_assets/img/cluster-resume.png)
4342

4443
(additional-info)=
45-
## Important things to know
44+
## Important things to know
4645

4746
- To suspend a cluster, you must be an organization Admin.
4847
- You can suspend and resume clusters at any time.
4948
- While your cluster is suspended, you will still be billed for the
5049
storage and the billing cycle is unaffected.
5150
- Cluster backups do not expire while a cluster is suspended.
5251
- The Admin UI of a cluster is unavailable while the cluster is
53-
suspended.
52+
suspended.

docs/reference/glossary.md

Lines changed: 55 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ to CrateDB Cloud. The items are presented in alphabetical order.
77

88
:::{note}
99
While learning about CrateDB Cloud, please also visit the {ref}`CrateDB
10-
glossary <crate-reference:appendix-glossary>`. It describes
10+
glossary <crate-reference:appendix-glossary>`. It describes
1111
all terms related to the CrateDB database in general.
1212
:::
1313

@@ -36,18 +36,18 @@ all terms related to the CrateDB database in general.
3636
- [Versions](#gloss-version)
3737

3838
(gloss-audit-log)=
39-
## Audit log
39+
## Audit log
4040

4141
The Audit Log registers and displays all operations associated with a
42-
particular {ref}`organization <gloss-org>`. This includes operations
43-
on {ref}`users <gloss-user>`, on {ref}`clusters <gloss-cluster>`, and
44-
on {ref}`consumers <gloss-consumer>`. The Audit Log can be found
45-
in the rightmost tab of the Organization overview page in the CrateDB
46-
Cloud {ref}`Console <gloss-console>`. Only an *organization admin* has
42+
particular {ref}`organization <gloss-org>`. This includes operations
43+
on {ref}`users <gloss-user>`, on {ref}`clusters <gloss-cluster>`, and
44+
on {ref}`consumers <gloss-consumer>`. The Audit Log can be found
45+
in the rightmost tab of the Organization overview page in the CrateDB
46+
Cloud {ref}`Console <gloss-console>`. Only an *organization admin* has
4747
access to the Audit Log.
4848

4949
(gloss-azure-ad)=
50-
## Azure AD
50+
## Azure AD
5151

5252
Azure AD (Active Directory) is Microsoft's authentication and sign-in
5353
service for accessing Microsoft hosted services. CrateDB Cloud uses
@@ -57,17 +57,17 @@ documentation on
5757
Azure](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis).
5858

5959
(gloss-cluster)=
60-
## Cluster
60+
## Cluster
6161

62-
Within each {ref}`organization <gloss-org>`, an administrator can
62+
Within each {ref}`organization <gloss-org>`, an administrator can
6363
deploy any number of {ref}`products <gloss-product>`. The main
6464
service is the deployment of clusters, which can be done through the
6565
CrateDB Cloud Console. A cluster is a set of at least one instance
6666
(referred to as node) which forms a database. It is also possible (and
6767
recommended) to deploy multi-node clusters. Then the the database is
6868
truly distributed. Depending on the user's {ref}`subscription
69-
plan <gloss-subscription-plan>` and scaling, each cluster will have a
70-
certain storage capacity and can process a certain amount of ingests
69+
plan <gloss-subscription-plan>` and scaling, each cluster will have a
70+
certain storage capacity and can process a certain amount of ingests
7171
and queries per second. Only actual cluster usage is billed.
7272

7373
A cluster has a name, a unique ID, as well as a storage and processing
@@ -77,7 +77,7 @@ deploying a CrateDB Cloud cluster from
7777
scratch](https://cratedb.com/docs/cloud/en/latest/tutorials/quick-start.html).
7878

7979
(gloss-console)=
80-
## Console
80+
## Console
8181

8282
The CrateDB Cloud Console is the hosted user interface for CrateDB
8383
Cloud. It is a fully supported, easy-to-use UI which allows customers to
@@ -88,7 +88,7 @@ use of the Console by default. Only the Console allows deployment of a
8888
{ref}`cluster <gloss-cluster>`.
8989

9090
(gloss-consumer)=
91-
## Consumer
91+
## Consumer
9292

9393
A consumer in the sense used for CrateDB Cloud architecture and
9494
documentation is an entity that reads event data from an IoT hub. It is
@@ -101,46 +101,46 @@ Operations on consumers are registered in the
101101

102102

103103
(gloss-croud)=
104-
## Croud
104+
## Croud
105105

106106
Croud is the name of the CrateDB Cloud Command-Line Interface (CLI). You
107-
can use Croud to interact with the {ref}`organization <gloss-org>` and
107+
can use Croud to interact with the {ref}`organization <gloss-org>` and
108108
{ref}`products <gloss-product>` you have access to.
109109

110110
Croud is intended for customers who prefer a CLI to the use of a hosted
111111
web interface such as the CrateDB Cloud
112-
{ref}`Console <gloss-console>`. Note however that the Console
113-
is the default way to interact with CrateDB Cloud, and currently
112+
{ref}`Console <gloss-console>`. Note however that the Console
113+
is the default way to interact with CrateDB Cloud, and currently
114114
clusters can only be deployed within the Console.
115115

116116
:::{note}
117117
See also: Croud CLI {ref}`documentation <cluster-deployment-croud>`.
118118
:::
119119

120120
(gloss-cloud-on-kubernetes)=
121-
## CrateDB Cloud on Kubernetes
121+
## CrateDB Cloud on Kubernetes
122122

123123
CrateDB Cloud on Kubernetes is a hybrid cloud database solution presented
124124
by [CrateDB](https://cratedb.com/). It allows customers to deploy a Kubernetes cluster either on
125-
their own cloud provider or their own local servers, using the database
126-
software and maintenance support that CrateDB Cloud offers. It can be
125+
their own cloud provider or their own local servers, using the database
126+
software and maintenance support that CrateDB Cloud offers. It can be
127127
accessed through the {ref}`CrateDB Cloud Console <gloss-console>`.
128128

129129
(gloss-endpoint)=
130-
## Endpoint
130+
## Endpoint
131131

132132
An endpoint is the end or goal of a communication channel. A user or
133133
client communicates with an endpoint via a defined method, which returns
134134
a defined set of data. In CrateDB Cloud, different
135-
{ref}`profiles <gloss-profile>` can be used to configure their own
136-
associated endpoints, which a user connects to via the
137-
{ref}`Croud <gloss-croud>` CLI. For information on how
135+
{ref}`profiles <gloss-profile>` can be used to configure their own
136+
associated endpoints, which a user connects to via the
137+
{ref}`Croud <gloss-croud>` CLI. For information on how
138138
to do this, see the {ref}`Croud configuration <cluster-deployment-croud>`.
139139

140140
(gloss-offer)=
141-
## Offer
141+
## Offer
142142

143-
An offer or subscription offer is a Software-as-a-Service
143+
An offer or subscription offer is a Software-as-a-Service
144144
{ref}`(SaaS) <gloss-saas>` product prepared for
145145
consumer purchase on a subscription basis. CrateDB Cloud has an offer on
146146
the [Microsoft Azure
@@ -149,11 +149,11 @@ and on the [AWS
149149
Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND).
150150

151151
(gloss-org)=
152-
## Organization
152+
## Organization
153153

154154
Organizations represent the larger structure - for example a company -
155-
within which CrateDB Cloud {ref}`products <gloss-product>` are deployed.
156-
At the organization level there is always at least one organization
155+
within which CrateDB Cloud {ref}`products <gloss-product>` are deployed.
156+
At the organization level there is always at least one organization
157157
administrator, who can in turn add organization
158158
members. Such organization admins and members have access to the
159159
clusters run by the organization. One account can be a member or admin
@@ -169,27 +169,27 @@ email address. For information on how to create an organization, please
169169
refer to the guide about {ref}`creating organization <create-org>`.
170170

171171
(gloss-product)=
172-
## Product
172+
## Product
173173

174174
A product in the sense used in CrateDB Cloud is something that uses the
175-
Cloud service for the storage of data. It consists of either a
176-
{ref}`consumer <gloss-consumer>` or a {ref}`cluster <gloss-cluster>` and
175+
Cloud service for the storage of data. It consists of either a
176+
{ref}`consumer <gloss-consumer>` or a {ref}`cluster <gloss-cluster>` and
177177
is run within an {ref}`organization <gloss-org>`.
178178

179179
(gloss-profile)=
180-
## Profile
180+
## Profile
181181

182-
In CrateDB Cloud's CLI, {ref}`Croud <gloss-croud>`, profiles are sets
183-
of configuration options. They define API {ref}`endpoints <gloss-endpoint>`
182+
In CrateDB Cloud's CLI, {ref}`Croud <gloss-croud>`, profiles are sets
183+
of configuration options. They define API {ref}`endpoints <gloss-endpoint>`
184184
and the desired output format of interaction with those endpoints. A Croud user
185185
can create multiple profiles and switch between them as desired.
186186

187187
(gloss-region)=
188-
## Region
188+
## Region
189189

190190
A region in the sense used for CrateDB Cloud is a set of data centers
191191
(servers) grouped together on a geographic basis so as to not exceed a
192-
certain latency. CrateDB Cloud on Kubernetes also permits the creation of
192+
certain latency. CrateDB Cloud on Kubernetes also permits the creation of
193193
custom regions. These regions are designed to correspond to servers used
194194
by CrateDB Cloud on Kubernetes customers locally, on which they can deploy
195195
CrateDB Cloud clusters for use in plants and other production facilities.
@@ -210,9 +210,9 @@ and the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND).
210210
## Scale unit
211211

212212
The CrateDB Cloud
213-
{ref}`subscription plans <gloss-subscription-plan>` each come with a number
214-
of different scale units. Each scale unit represents an (additional)
215-
unit multiplying the specific combination of hardware capacity
213+
{ref}`subscription plans <gloss-subscription-plan>` each come with a number
214+
of different scale units. Each scale unit represents an (additional)
215+
unit multiplying the specific combination of hardware capacity
216216
that applies to that plan.
217217

218218
:::{note}
@@ -225,8 +225,7 @@ cluster guide](https://crate.io/docs/cloud/howtos/en/latest/reconfigure-cluster.
225225

226226
A subscription is - for the purposes of CrateDB Cloud - a container in
227227
which the CrateDB Cloud service is created and managed. You can purchase
228-
a CrateDB Cloud subscription by following the steps in the
229-
[tutorial](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/index.html).
228+
a CrateDB Cloud subscription by signing up at [CrateDB Cloud].
230229
In the case of using a {ref}`SaaS <gloss-saas>` {ref}`offers <gloss-offer>` on the cloud
231230
provider marketplaces, customers subscribe to CrateDB Cloud through that
232231
particular cloud provider.
@@ -238,16 +237,15 @@ wants to separate different instances of using the CrateDB Cloud service
238237
into different billing accounts.
239238

240239
:::{note}
241-
[Subscribe to CrateDB
242-
Cloud](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html)
240+
[Subscribe to CrateDB Cloud](https://console.cratedb.cloud)
243241

244242
[Subscribe via AWS
245243
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-aws/subscribe-aws.html)
246244

247245
[Subscribe via Azure
248246
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html)
249247

250-
{ref}`Services <services>`
248+
{ref}`Services <services>`
251249
:::
252250

253251
(gloss-subscription-plan)=
@@ -259,24 +257,22 @@ towards particular customer use cases: from trial and development plans
259257
to high-end production clusters. They can also be further adjusted for
260258
different {ref}`scale units <gloss-scale-unit>` per plan.
261259

262-
Currently, there are multiple subscription plans available for {ref}`direct
263-
deployment <deploy-cluster>`, and also multiple plans and a separate contract option
264-
through the Marketplace {ref}`offers <gloss-offer>`. For more information,
265-
refer to the documentation on {ref}` services we offer <services>`.
260+
There are multiple subscription plans available for direct
261+
deployment, and also multiple plans and a separate contract option
262+
through the Marketplace {ref}`offers <gloss-offer>`. For more information,
263+
refer to the documentation on {ref}`services we offer <services>`.
266264

267265
:::{note}
268266
See also:
269267

270-
[Subscribe to CrateDB
271-
Cloud](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html)
268+
[Subscribe to CrateDB Cloud](https://console.cratedb.cloud)
272269

273270
[Subscribe via AWS
274271
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-aws/subscribe-aws.html)
275272

276273
[Subscribe via Azure
277274
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html)
278275

279-
{ref}`Deployment <cluster-deployment>`
280276
:::
281277

282278
(gloss-system-user)=
@@ -298,18 +294,18 @@ In CrateDB Cloud, there are two distinct system
298294
## Tier
299295

300296
In the CrateDB Cloud
301-
{ref}`services <services>` for SaaS Marketplace
302-
subscriptions, tiers offer different magnitudes of the hardware
303-
composition of a given plan. For a given ratio of storage capacity,
304-
memory, and CPUs, going up in tier allows youto multiply
297+
{ref}`services <services>` for SaaS Marketplace
298+
subscriptions, tiers offer different magnitudes of the hardware
299+
composition of a given plan. For a given ratio of storage capacity,
300+
memory, and CPUs, going up in tier allows youto multiply
305301
the hardware values for your cluster deployment without
306302
changing the hardware ratio.
307303

308304
(gloss-user)=
309305
## User
310306

311307
A user in CrateDB Cloud is any individual account authorized to interact
312-
with some part of an {ref}`organization's <gloss-org>` assets. Each user has
308+
with some part of an {ref}`organization's <gloss-org>` assets. Each user has
313309
a defined role within the organization (see documentation on {ref}`user roles
314310
<user-roles>`) and is associated with a
315311
specific email address.
@@ -341,7 +337,7 @@ the versioning sequence, e.g. the 3 in 'version 5.3.4'.
341337
A patch version of CrateDB is a release that includes bug fixes and
342338
smaller quality of life improvements compared to the previous such
343339
version. It is indicated by the third numeral in the versioning
344-
sequence, e.g. the 4 in 'version 5.3.4'.
340+
sequence, e.g. the 4 in 'version 5.3.4'.
345341

346342
:::{note}
347343
See also: {ref}`CrateDB Release Notes <crate-reference:release_notes>`

docs/tutorials/deploy/croud.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
This tutorial will outline a step-by-step guide to deploying a cluster
55
using the Cloud CLI application from scratch. The walkthrough assumes
6-
you have completed the {ref}`signup process <quick-start>` successfully,
7-
and that the `croud` program {ref}`is installed <cloud-cli:getting-started>`
6+
you have completed the [signup process](https://console.cratedb.cloud)
7+
successfully, and that the `croud` program {ref}`is installed <cloud-cli:getting-started>`
88
on your system.
99

1010
::::{grid} 1 1 1 1
@@ -240,8 +240,8 @@ Required arguments:
240240

241241
* `--unit 0` means **1 node**
242242
* `--unit 1` means **2 nodes**
243-
* `--unit 2` means **3 nodes** etc.
244-
243+
* `--unit 2` means **3 nodes** etc.
244+
245245
This allows you to scale the performance of your cluster up or
246246
down.
247247

0 commit comments

Comments
 (0)