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

docs: Demo deployments & workspace tools page #7639

Merged
merged 2 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
25 changes: 17 additions & 8 deletions docs/pages/product/configuration/data-sources/duckdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[DuckDB][duckdb] is an in-process SQL OLAP database management system, and has
support for querying data in CSV, JSON and Parquet formats from an AWS
S3-compatible blob storage. This means you can [query data stored in AWS S3,
Google Cloud Storage, or CloudFlare R2][duckdb-docs-s3-import].
Google Cloud Storage, or Cloudflare R2][duckdb-docs-s3-import].

<Diagram src="https://ucarecdn.com/d3e42677-83ce-4ad8-8ac9-c39d3b74e252/" />

Expand Down Expand Up @@ -33,19 +33,27 @@ CUBEJS_DB_TYPE=duckdb

### Cube Cloud

In Cube Cloud, select **DuckDB** when creating a new deployment and fill in the
required fields:
In Cube Cloud, select&nbsp;<Btn>DuckDB</Btn> when creating a new deployment
and fill in the required fields:

<Screenshot
alt="Cube Cloud DuckDB Configuration Screen"
src="https://ucarecdn.com/ffad02b1-a563-47e4-bbc0-0302ab046ccd/"
/>

<InfoBox>

If you are not using MotherDuck, leave the **MotherDuck Token** field blank.
If you are not using MotherDuck, leave the&nbsp;<Btn>MotherDuck Token</Btn>
field blank.

</InfoBox>

<Screenshot
alt="Cube Cloud DuckDB Configuration Screen"
src="https://ucarecdn.com/ffad02b1-a563-47e4-bbc0-0302ab046ccd/"
/>
<InfoBox>

You can also explore how DuckDB works with Cube if you create a [demo
deployment][ref-demo-deployment] in Cube Cloud.

</InfoBox>

## Environment Variables

Expand Down Expand Up @@ -124,3 +132,4 @@ connections are made over HTTPS.
[ref-schema-ref-types-formats-countdistinctapprox]:
/reference/data-model/types-and-formats#count-distinct-approx
[self-preaggs-batching]: #batching
[ref-demo-deployment]: /product/deployment/cloud/deployments#demo-deployments
8 changes: 8 additions & 0 deletions docs/pages/product/data-modeling/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ exposed through the [querying API][ref-backend-restapi] that allows end-users to
query a wide variety of analytical queries without modifying the data model
itself.

<InfoBox>

You can explore a carefully crafted sample data model if you create a [demo
deployment][ref-demo-deployment] in Cube Cloud.

</InfoBox>

Let’s use a users table with the following columns as an example:

| id | paying | city | company_name |
Expand Down Expand Up @@ -302,3 +309,4 @@ As with other measures, `paying_percentage` can be used with dimensions.
[ref-schema-types-formats]: /reference/data-model/types-and-formats
[ref-examples]: /guides/examples
[ref-backend-query-format]: /product/apis-integrations/rest-api/query-format
[ref-demo-deployment]: /product/deployment/cloud/deployments#demo-deployments
52 changes: 51 additions & 1 deletion docs/pages/product/deployment/cloud/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,48 @@ the&nbsp;<Btn>Cube Cloud</Btn> logo in the top left corner.

<Screenshot src="https://ucarecdn.com/cdd5831a-a8f8-4342-bc3e-25aab2c04a5b/"/>

## Creating a new deployment

Creating a new deployment is an essential prerequisite to running a Cube
project in Cube Cloud.

After you've created your [Cube Cloud account][cube-cloud-signup],
click&nbsp;<Btn>+ Create Deployment</Btn> in the top-right corner of your
list of deployments to jump into the wizard. Watch the following video for
guidance on the rest of the steps:

<YouTubeVideo url="https://www.youtube.com/embed/HVZ4ytDEjqc" />

## Demo deployments

After you've created your [Cube Cloud account][cube-cloud-signup] and
proceeded to create a new deployment, you would be prompted to set up a
connection to your [data source][ref-data-source].

If, for any reason, you're not ready or unable to connect your staging or
production data source at the moment, you can click&nbsp;<Btn>Create a demo
deployment</Btn> in the yellow box:

<Screenshot src="https://ucarecdn.com/559aeebe-d20f-4510-a22c-62532b59cbcc/"/>

Shortly, Cube Cloud will create and pre-configure a new deployment in your
account. You will see it as&nbsp;<Btn>Demo deployment</Btn> in the list of
deployments. This new deployment will be:

- Configured to use [DuckDB][ref-duckdb] as the data source.
- Provided with a sample [data model][ref-data-model] backed with CSV files
in a public S3 bucket.
- Provided with an example of [dynamic data modeling][ref-dynamic-data-models]
and programmatic [configuration options][ref-config-options].

Watch the following video to for a step-by-step walkthrough:

<YouTubeVideo url="https://www.youtube.com/embed/XeaZPUQRC8M" />

Exploring the demo deployment is a great way to understand how Cube works.
Use the [data model editor][ref-data-model] to review the data model and
make sure to run a few queries in [Playground][ref-playground].

## Deployment overview

The&nbsp;<Btn>Overview</Btn> page of each deployment provides a high-level
Expand Down Expand Up @@ -59,8 +101,16 @@ Please refer to [total cost examples][ref-total-cost] to learn more about
resource consumption in different scenarios.


[cube-cloud-signup]: https://cubecloud.dev/auth/signup
[ref-deployment-types]: /product/deployment/cloud/deployment-types
[ref-dev-instance]: /product/deployment/cloud/deployment-types#development-instance
[ref-dev-mode]: /product/workspace/dev-mode
[ref-auto-sus]: /product/deployment/cloud/auto-suspension
[ref-total-cost]: /product/deployment/cloud/pricing#total-cost-examples
[ref-total-cost]: /product/deployment/cloud/pricing#total-cost-examples
[ref-data-source]: /product/configuration/data-sources
[ref-duckdb]: /product/configuration/data-sources/duckdb
[ref-data-model]: /product/data-modeling/overview
[ref-dynamic-data-models]: /product/data-modeling/dynamic
[ref-config-options]: /product/configuration#configuration-options
[ref-data-model]: /product/workspace/data-model
[ref-playground]: /product/workspace/playground
61 changes: 51 additions & 10 deletions docs/pages/product/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,62 @@ redirect_from:

# Getting started with Cube

Cube is a cloud-native application, packaged and distributed as Docker images
and designed to run in a containerized environment.
Cube is a cloud-native application, designed to run in a cloud. You can get
started with Cube in one of two ways:
- Run Cube in Cube Cloud and use its managed infrastructure and workspace tools.
- Deploy Cube to your own infrastructure with Docker.

You can get started with Cube in one of two ways.
## Getting started with Cube Cloud

We recommend using [Cube Cloud][cube-cloud], our managed platform for Cube,
because it's the easiest way to build, test, deploy, and manage Cube projects.
Cube Cloud includes features such as collaboration for teams, a web-based data
model editor, auto-scaling, and observability. Cube Cloud also comes with a free
tier for development and proof-of-concept projects.
**We recommend using [Cube Cloud][cube-cloud], our managed platform for Cube.**
It's the easiest way to build, test, deploy, and manage Cube projects and
it comes with a free tier for development and proof-of-concept projects.

Alternatively, you can run Cube on your own infrastructure with Docker.
Cube Cloud provides [managed infrastructure][ref-infrastructure] and
[workspace tools][ref-workspace], including features such as collaboration
for teams, a web-based data model editor, synchronization with BI tools,
auto-scaling, and observability.

Please get started with the following guides, tailored for Snowflake and
Databricks users. You may find them insightful even if you
have one of many other supported [data sources][ref-data-sources].

<Grid cols={2} imageSize={[undefined, 50]}>
<GridItem
url="getting-started/cloud"
imageUrl="https://static.cube.dev/icons/cube.svg"
title="Cube Cloud"
title="Cube Cloud and Snowflake"
/>
<GridItem
url="getting-started/databricks"
imageUrl="https://static.cube.dev/icons/cube.svg"
title="Cube Cloud and Databricks"
/>
</Grid>

Alternatively, you can explore Cube Cloud on your own or learn by example
in a demo deployment:

<Grid cols={3} imageSize={[undefined, 50]}>
<GridItem
url="deployment/cloud/deployments#creating-a-new-deployment"
imageUrl="https://static.cube.dev/icons/cube.svg"
title="Create a new deployment"
/>
<GridItem
url="deployment/cloud/deployments#demo-deployments"
imageUrl="https://static.cube.dev/icons/cube.svg"
title="Create a demo deployment"
/>
</Grid>

## Getting started with Cube Core

Cube Core is packaged and distributed as Docker images that can be run in
a containerized environment. You can run Cube Cube on your own
infrastructure with Docker.

<Grid cols={2} imageSize={[undefined, 50]}>
<GridItem
url="getting-started/core"
imageUrl="https://static.cube.dev/icons/docker.svg"
Expand All @@ -41,4 +78,8 @@ Cube Cloud supports several ways for importing existing Cube projects:
- [Import a Git repository](/product/getting-started/migrate-from-core/import-git-repository-via-ssh)
- [Import a local project with CLI](/product/getting-started/migrate-from-core/upload-with-cli)

[cube-repo]: https://github.com/cube-js/cube
[cube-cloud]: https://cube.dev/cloud/
[ref-infrastructure]: /product/deployment/cloud
[ref-workspace]: /product/workspace
[ref-data-sources]: /product/configuration/data-sources
2 changes: 1 addition & 1 deletion docs/pages/product/getting-started/_meta.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
"core": "Cube Core",
"cloud": "Cube Cloud and Snowflake",
"databricks": "Cube Cloud and Databricks",
"core": "Cube Core",
"migrate-from-core": "Migrate from Cube Core"
}
56 changes: 56 additions & 0 deletions docs/pages/product/workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Workspace

Workspace tools are designed to help you build, test, deploy, and manage
Cube projects.

<SuccessBox>

Most workspace tools depend on the [managed infrastructure][ref-infrastructure]
and are only available in Cube Cloud.

</SuccessBox>

## Workspace tools in Cube Cloud

In Cube Cloud, you can:
* Use the [data model editor][ref-data-model] with the [development
mode][ref-dev-mode] to build the data model of your semantic layer.
* Use [SQL Runner][ref-sql-runner] to inform the development of the data
model.
* Use [Playground][ref-playground] to run queries and test the data model.
* Use [Semantic Layer Sync][ref-sls] to connect your semantic layer to BI
tools.
* Use [Query Hsitory][ref-query-history] to observe queries and their
performance in real-time.
* Use the [pre-aggregations page][ref-pre-aggs] to inspect pre-aggregations
and their build history.
* Use [Performance Insights][ref-perf-insights] to analyze the performance
of your deployment as a whole.
* Use the [access control page][ref-access-control] to manage users of your
Cube Cloud account and [single sign-on][ref-sso].
* Use [Budgets][ref-budgets] to control the usage and spend of your Cube
Cloud account.
* Use [Preferences][ref-prefs] to adjust the workspace to your liking.

## Workspace tools in Cube Core

With Cube Core, you can:

* Use the data model builder to generate the initial data model.
* Use [Playground][ref-playground] to run queries and test the data model.
* Use the [command-line tool][ref-cli] to automate your workflows.

[ref-infrastructure]: /product/deployment/cloud
[ref-data-model]: /product/workspace/data-model
[ref-dev-mode]: /product/workspace/dev-mode
[ref-sql-runner]: /product/workspace/sql-runner
[ref-playground]: /product/workspace/playground
[ref-sls]: /product/workspace/semantic-layer-sync
[ref-query-history]: /product/workspace/query-history
[ref-pre-aggs]: /product/workspace/pre-aggregations
[ref-perf-insights]: /product/workspace/performance
[ref-access-control]: /product/workspace/access-control
[ref-sso]: /product/workspace/sso
[ref-budgets]: /product/workspace/budgets
[ref-prefs]: /product/workspace/preferences
[ref-cli]: /product/workspace/cli
Loading