Skip to content

chore: update document for cloud #89

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

Merged
merged 5 commits into from
Sep 25, 2024
Merged

chore: update document for cloud #89

merged 5 commits into from
Sep 25, 2024

Conversation

xieydd
Copy link
Member

@xieydd xieydd commented Aug 29, 2024

Add document for authorization, API key and backup&restore.

Copy link

vercel bot commented Aug 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
pgvecto-rs-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 20, 2024 6:40am

Copy link

cloudflare-workers-and-pages bot commented Aug 29, 2024

Deploying pgvecto-rs-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6ef3608
Status: ✅  Deploy successful!
Preview URL: https://777e1a2e.pgvecto-rs-docs.pages.dev
Branch Preview URL: https://cloud-doc.pgvecto-rs-docs.pages.dev

View logs

@@ -14,6 +14,10 @@ We provide two types of connection endpoints:
- Super User Endpoint: This connection string is used to connect to the cluster as a superuser(postgres). You can use this connection string to create databases, users, and manage the cluster.
- Vector User Endpoint: This connection string is used to connect to the cluster as a vector user. You can use this connection string to store and query vector data.

If you enable pooler connection, you can get the pooler connection endpoint via clicking the `Show Pooler Endpoint` button.
Copy link
Member

Choose a reason for hiding this comment

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

We can indicate that it is at create cluster that the enable pooler connection is selected.

If the Connection Pooler is enabled at cluster creation,

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

- Enter a name for the API key.
- Select the role for the API key.
- **Owner**: The owner has full access to the project cluster.
- **Member**: The member has read-only access to the project cluster, but you can specify clusters full access.
Copy link
Member

Choose a reason for hiding this comment

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

The member has read-only access to the project cluster. However, you can specify clusters to which the member has full access.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

- You can view the list of API keys with their respective roles.

::: warning
If you are not the owner of the project, you will not be able to view the list of API keys.
Copy link
Member

Choose a reason for hiding this comment

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

If you are not the project owner, you will not have access to the list of API keys.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: xieydd <[email protected]>


::: warning
The cluster you are restoring to should have the same images and database as the backup or cluster.
Copy link
Member

Choose a reason for hiding this comment

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

Here

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: xieydd <[email protected]>
Signed-off-by: xieydd <[email protected]>
@gaocegege gaocegege merged commit 86a6aec into main Sep 25, 2024
5 checks passed
@gaocegege gaocegege deleted the cloud-doc branch September 25, 2024 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants