Skip to content

Commit b9ce174

Browse files
g-despotg-despot
committed
Cluster details updates
1 parent 1c832db commit b9ce174

5 files changed

Lines changed: 97 additions & 72 deletions

File tree

‎_includes/wcs/retrieve-api-keys.mdx‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎docs/cloud/manage-clusters/authentication.mdx‎

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,17 +225,68 @@ If [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) is
225225

226226
If you have a Serverless cluster, you can create, delete, edit, and rotate API keys. You cannot modify the Sandbox cluster keys.
227227

228-
### Retrieve an API keys
228+
### Retrieve an API key
229229

230-
import RetrieveAPIKeys from '/_includes/wcs/retrieve-api-keys.mdx';
230+
When connecting to a Weaviate Cloud cluster, you need an API key and the REST endpoint URL for authentication.
231+
To retrieve your connection details, follow these steps:
231232

232-
<RetrieveAPIKeys />
233+
import Link from '@docusaurus/Link';
234+
import Register from '/docs/cloud/img/weaviate-cloud-api-keys.png';
235+
236+
<div class="row">
237+
<ol>
238+
<li className="inline-content">
239+
Open the <Link to="https://console.weaviate.cloud">Weaviate Cloud console</Link> and <Link to="/cloud/manage-clusters/status#select-your-cluster"> ssselect your cluster</Link>.
240+
</li>
241+
<li>
242+
On the <code>Cluster details</code> page, find the <code>Admin</code> API
243+
key and <code>REST Endpoint</code> URL.
244+
</li>
245+
<li>Copy the needed key and URL and store them in a safe location.</li>
246+
</ol>
247+
</div>
248+
249+
import WCDClusterURL from '/docs/weaviate/quickstart/img/cluster_url.png';
250+
import WCDClusterAdminKey from '/docs/weaviate/quickstart/img/cluster_admin_key.png';
251+
252+
<div class="row">
253+
<div class="col col--6">
254+
<div class="card-demo">
255+
<div class="card">
256+
<div class="card__image">
257+
<img src={WCDClusterURL} alt="Get the (REST) endpoint URL" />
258+
</div>
259+
<div class="card__body">
260+
Grab the <code>REST Endpoint</code> URL.
261+
</div>
262+
</div>
263+
</div>
264+
</div>
265+
<div class="col col--6">
266+
<div class="card-demo">
267+
<div class="card">
268+
<div class="card__image">
269+
<img src={WCDClusterAdminKey} alt="Get the admin API key" />
270+
</div>
271+
<div class="card__body">
272+
Grab the <code>Admin</code> API key.
273+
</div>
274+
</div>
275+
</div>
276+
</div>
277+
</div>
278+
<br />
279+
280+
:::note REST Endpoint vs gRPC Endpoint
281+
282+
When using an official Weaviate [client library](/weaviate/client-libraries), you need to authenticate using the `REST Endpoint`. The client will infer the gRPC endpoint automatically and use the more performant gRPC protocol when available.
283+
284+
:::
233285

234286
### Create an API key
235287

236288
If you have a Serverless cluster, you can create new API keys. To create a new API key, follow these steps:
237289

238-
import Link from '@docusaurus/Link';
239290
import NewAPIKey from '/docs/cloud/img/weaviate-cloud-new-api-key.png';
240291

241292
<div class="row">

‎docs/cloud/quickstart.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ Go to the [Weaviate Cloud console](https://console.weaviate.cloud) and create a
9797
}}
9898
>
9999
<iframe
100-
id="xrgwlygc1p"
101-
src="https://app.guideflow.com/embed/xrgwlygc1p"
100+
id="qp7xdo7cjr"
101+
src="https://app.guideflow.com/embed/qp7xdo7cjr"
102102
width="100%"
103103
height="100%"
104104
style={{ overflow: 'hidden', position: 'absolute', border: 'none' }}
@@ -111,7 +111,7 @@ Go to the [Weaviate Cloud console](https://console.weaviate.cloud) and create a
111111
/>
112112
<script
113113
src="https://app.guideflow.com/assets/opt.js"
114-
data-iframe-id="xrgwlygc1p"
114+
data-iframe-id="qp7xdo7cjr"
115115
></script>
116116
</div>
117117

@@ -162,8 +162,8 @@ New clusters with Weaviate version `v1.30` (or later) have [RBAC (Role-Based Acc
162162
}}
163163
>
164164
<iframe
165-
id="mk6zxyws6p"
166-
src="https://app.guideflow.com/embed/mk6zxyws6p"
165+
id="ok8l954sxr"
166+
src="https://app.guideflow.com/embed/ok8l954sxr"
167167
width="100%"
168168
height="100%"
169169
style={{ overflow: 'hidden', position: 'absolute', border: 'none' }}
@@ -176,7 +176,7 @@ New clusters with Weaviate version `v1.30` (or later) have [RBAC (Role-Based Acc
176176
/>
177177
<script
178178
src="https://app.guideflow.com/assets/opt.js"
179-
data-iframe-id="mk6zxyws6p"
179+
data-iframe-id="ok8l954sxr"
180180
></script>
181181
</div>
182182

‎docs/weaviate/connections/connect-cloud.mdx‎

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,39 @@ import JavaCode from '!!raw-loader!/_includes/code/connections/connect.java';
1515
import ShellCode from '!!raw-loader!/_includes/code/connections/connect.sh';
1616
import GoCode from '!!raw-loader!/_includes/code/connections/connect.go';
1717

18-
Follow these steps to connect to a Weaviate Cloud (WCD) instance.
18+
Follow these steps to connect to a [Weaviate Cloud (WCD)](https://console.weaviate.cloud/) instance.
1919

2020
## Retrieve your API key and REST endpoint
2121

22-
import RetrieveAPIKeys from '/_includes/wcs/retrieve-api-keys.mdx';
23-
24-
<RetrieveAPIKeys />
22+
Open the [Weaviate Cloud console](https://console.weaviate.cloud/) and follow the steps below:
23+
24+
<div
25+
style={{
26+
position: 'relative',
27+
paddingBottom: 'calc(54.10879629629629% + 50px)',
28+
height: 0,
29+
}}
30+
>
31+
<iframe
32+
id="ok8l954sxr"
33+
src="https://app.guideflow.com/embed/ok8l954sxr"
34+
width="100%"
35+
height="100%"
36+
style={{ overflow: 'hidden', position: 'absolute', border: 'none' }}
37+
scrolling="no"
38+
allow="clipboard-read; clipboard-write"
39+
webKitAllowFullScreen
40+
mozAllowFullScreen
41+
allowFullScreen
42+
allowTransparency="true"
43+
/>
44+
<script
45+
src="https://app.guideflow.com/assets/opt.js"
46+
data-iframe-id="ok8l954sxr"
47+
></script>
48+
</div>
49+
50+
<br />
2551

2652
## Connection example
2753

‎docs/weaviate/quickstart/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ Go to the [Weaviate Cloud console](https://console.weaviate.cloud) and create a
8989

9090
<div style={{position: "relative", paddingBottom: "calc(54.10879629629629% + 50px)", height: 0}}>
9191
<iframe
92-
id="xrgwlygc1p"
93-
src="https://app.guideflow.com/embed/xrgwlygc1p"
92+
id="qp7xdo7cjr"
93+
src="https://app.guideflow.com/embed/qp7xdo7cjr"
9494
width="100%"
9595
height="100%"
9696
style={{overflow: "hidden", position: "absolute", border: "none"}}
@@ -101,7 +101,7 @@ Go to the [Weaviate Cloud console](https://console.weaviate.cloud) and create a
101101
allowFullScreen
102102
allowTransparency="true"
103103
/>
104-
<script src="https://app.guideflow.com/assets/opt.js" data-iframe-id="xrgwlygc1p"></script>
104+
<script src="https://app.guideflow.com/assets/opt.js" data-iframe-id="qp7xdo7cjr"></script>
105105
</div>
106106

107107
<br/>
@@ -143,8 +143,8 @@ New clusters with Weaviate version `v1.30` (or later) have [RBAC (Role-Based Acc
143143

144144
<div style={{position: "relative", paddingBottom: "calc(54.10879629629629% + 50px)", height: 0}}>
145145
<iframe
146-
id="mk6zxyws6p"
147-
src="https://app.guideflow.com/embed/mk6zxyws6p"
146+
id="ok8l954sxr"
147+
src="https://app.guideflow.com/embed/ok8l954sxr"
148148
width="100%"
149149
height="100%"
150150
style={{overflow: "hidden", position: "absolute", border: "none"}}
@@ -155,7 +155,7 @@ New clusters with Weaviate version `v1.30` (or later) have [RBAC (Role-Based Acc
155155
allowFullScreen
156156
allowTransparency="true"
157157
/>
158-
<script src="https://app.guideflow.com/assets/opt.js" data-iframe-id="mk6zxyws6p"></script>
158+
<script src="https://app.guideflow.com/assets/opt.js" data-iframe-id="ok8l954sxr"></script>
159159
</div>
160160

161161
<br/>

0 commit comments

Comments
 (0)