Skip to content

Commit ae519ff

Browse files
authored
Fix links to removed pages. (#107)
1 parent 87f4b78 commit ae519ff

File tree

9 files changed

+88
-312
lines changed

9 files changed

+88
-312
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: 56 additions & 62 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,27 +57,25 @@ 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
7474
capacity and a number of nodes. Note that clusters are also versioned.
75-
For information on how to deploy a cluster, please see the [tutorial for
76-
deploying a CrateDB Cloud cluster from
77-
scratch](https://cratedb.com/docs/cloud/en/latest/tutorials/quick-start.html).
75+
You can deploy a free cluster in [CrateDB Cloud](https://console.cratedb.cloud).
7876

7977
(gloss-console)=
80-
## Console
78+
## Console
8179

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

9088
(gloss-consumer)=
91-
## Consumer
89+
## Consumer
9290

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

102100

103101
(gloss-croud)=
104-
## Croud
102+
## Croud
105103

106104
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
105+
can use Croud to interact with the {ref}`organization <gloss-org>` and
108106
{ref}`products <gloss-product>` you have access to.
109107

110108
Croud is intended for customers who prefer a CLI to the use of a hosted
111109
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
110+
{ref}`Console <gloss-console>`. Note however that the Console
111+
is the default way to interact with CrateDB Cloud, and currently
114112
clusters can only be deployed within the Console.
115113

116114
:::{note}
117115
See also: Croud CLI {ref}`documentation <cluster-deployment-croud>`.
118116
:::
119117

120118
(gloss-cloud-on-kubernetes)=
121-
## CrateDB Cloud on Kubernetes
119+
## CrateDB Cloud on Kubernetes
122120

123121
CrateDB Cloud on Kubernetes is a hybrid cloud database solution presented
124122
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
123+
their own cloud provider or their own local servers, using the database
124+
software and maintenance support that CrateDB Cloud offers. It can be
127125
accessed through the {ref}`CrateDB Cloud Console <gloss-console>`.
128126

129127
(gloss-endpoint)=
130-
## Endpoint
128+
## Endpoint
131129

132130
An endpoint is the end or goal of a communication channel. A user or
133131
client communicates with an endpoint via a defined method, which returns
134132
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
133+
{ref}`profiles <gloss-profile>` can be used to configure their own
134+
associated endpoints, which a user connects to via the
135+
{ref}`Croud <gloss-croud>` CLI. For information on how
138136
to do this, see the {ref}`Croud configuration <cluster-deployment-croud>`.
139137

140138
(gloss-offer)=
141-
## Offer
139+
## Offer
142140

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

151149
(gloss-org)=
152-
## Organization
150+
## Organization
153151

154152
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
153+
within which CrateDB Cloud {ref}`products <gloss-product>` are deployed.
154+
At the organization level there is always at least one organization
157155
administrator, who can in turn add organization
158156
members. Such organization admins and members have access to the
159157
clusters run by the organization. One account can be a member or admin
@@ -169,27 +167,27 @@ email address. For information on how to create an organization, please
169167
refer to the guide about {ref}`creating organization <create-org>`.
170168

171169
(gloss-product)=
172-
## Product
170+
## Product
173171

174172
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
173+
Cloud service for the storage of data. It consists of either a
174+
{ref}`consumer <gloss-consumer>` or a {ref}`cluster <gloss-cluster>` and
177175
is run within an {ref}`organization <gloss-org>`.
178176

179177
(gloss-profile)=
180-
## Profile
178+
## Profile
181179

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

187185
(gloss-region)=
188-
## Region
186+
## Region
189187

190188
A region in the sense used for CrateDB Cloud is a set of data centers
191189
(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
190+
certain latency. CrateDB Cloud on Kubernetes also permits the creation of
193191
custom regions. These regions are designed to correspond to servers used
194192
by CrateDB Cloud on Kubernetes customers locally, on which they can deploy
195193
CrateDB Cloud clusters for use in plants and other production facilities.
@@ -210,9 +208,9 @@ and the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND).
210208
## Scale unit
211209

212210
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
211+
{ref}`subscription plans <gloss-subscription-plan>` each come with a number
212+
of different scale units. Each scale unit represents an (additional)
213+
unit multiplying the specific combination of hardware capacity
216214
that applies to that plan.
217215

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

226224
A subscription is - for the purposes of CrateDB Cloud - a container in
227225
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).
226+
a CrateDB Cloud subscription by signing up at [CrateDB Cloud].
230227
In the case of using a {ref}`SaaS <gloss-saas>` {ref}`offers <gloss-offer>` on the cloud
231228
provider marketplaces, customers subscribe to CrateDB Cloud through that
232229
particular cloud provider.
@@ -238,16 +235,15 @@ wants to separate different instances of using the CrateDB Cloud service
238235
into different billing accounts.
239236

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

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

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

250-
{ref}`Services <services>`
246+
{ref}`Services <services>`
251247
:::
252248

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

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>`.
258+
There are multiple subscription plans available for direct
259+
deployment, and also multiple plans and a separate contract option
260+
through the Marketplace {ref}`offers <gloss-offer>`. For more information,
261+
refer to the documentation on {ref}`services we offer <services>`.
266262

267263
:::{note}
268264
See also:
269265

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

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

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

279-
{ref}`Deployment <cluster-deployment>`
280274
:::
281275

282276
(gloss-system-user)=
@@ -298,18 +292,18 @@ In CrateDB Cloud, there are two distinct system
298292
## Tier
299293

300294
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
295+
{ref}`services <services>` for SaaS Marketplace
296+
subscriptions, tiers offer different magnitudes of the hardware
297+
composition of a given plan. For a given ratio of storage capacity,
298+
memory, and CPUs, going up in tier allows youto multiply
305299
the hardware values for your cluster deployment without
306300
changing the hardware ratio.
307301

308302
(gloss-user)=
309303
## User
310304

311305
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
306+
with some part of an {ref}`organization's <gloss-org>` assets. Each user has
313307
a defined role within the organization (see documentation on {ref}`user roles
314308
<user-roles>`) and is associated with a
315309
specific email address.
@@ -341,7 +335,7 @@ the versioning sequence, e.g. the 3 in 'version 5.3.4'.
341335
A patch version of CrateDB is a release that includes bug fixes and
342336
smaller quality of life improvements compared to the previous such
343337
version. It is indicated by the third numeral in the versioning
344-
sequence, e.g. the 4 in 'version 5.3.4'.
338+
sequence, e.g. the 4 in 'version 5.3.4'.
345339

346340
:::{note}
347341
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)