diff --git a/_partials/_cloud-connect-service.md b/_partials/_cloud-connect-service.md index 853d08dbce..dc0c57a3d0 100644 --- a/_partials/_cloud-connect-service.md +++ b/_partials/_cloud-connect-service.md @@ -10,19 +10,19 @@ import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-fre 1. **Connect to your $SERVICE_SHORT** - Connect using data mode or SQL editor in $CONSOLE, or psql in the command line: + Connect using $DATA_MODE or SQL editor in $CONSOLE, or psql in the command line: - + - 1. In $CONSOLE, toggle `Data`. + 1. In $CONSOLE, click `Data view`. - 1. Select your $SERVICE_SHORT in the connection drop-down in the top right. + 1. In the connection drop-down in the top right, select your $SERVICE_SHORT. ![Select a connection](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode-connection-dropdown.png) @@ -95,18 +95,18 @@ import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-fre Quick recap. You: -- Manage your $SERVICE_SHORTs in the [$OPS_MODE][portal-ops-mode] in $CONSOLE: add $READ_REPLICAs and enable +- Manage your $SERVICE_SHORTs in $CONSOLE: add $READ_REPLICAs and enable high availability, compress data into the $COLUMNSTORE, change parameters, and so on. - Analyze your data in the [$DATA_MODE][portal-data-mode] in $CONSOLE: write queries with autocomplete, save them in folders, share them, create charts/dashboards, and much more. - Store configuration and security information in your config file. [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql [account-portal]: https://console.cloud.timescale.com/dashboard/account [services-portal]: https://console.cloud.timescale.com/dashboard/services [install-psql]: /integrations/:currentVersion:/psql/ -[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-view [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor [install-psql]: /integrations/:currentVersion:/psql/ [hypertables]: /use-timescale/:currentVersion:/hypertables/#hypertable-partitioning diff --git a/_partials/_create-hypertable.md b/_partials/_create-hypertable.md index 46ab0ba998..ef8e815533 100644 --- a/_partials/_create-hypertable.md +++ b/_partials/_create-hypertable.md @@ -9,7 +9,7 @@ To create a hypertable: 1. **Connect to your service** - In $CONSOLE, click `Data`, then select a $SERVICE_SHORT. + In $CONSOLE, click `Data view`, then select a $SERVICE_SHORT. 1. **Create a $PG table** @@ -29,13 +29,13 @@ To create a hypertable: You see the result immediately: - ![Data mode create table](https://assets.timescale.com/docs/images/data-mode-create-table.png) + ![Data view create table](https://assets.timescale.com/docs/images/data-mode-create-table.png) [services-portal]: https://console.cloud.timescale.com/dashboard/services [install-psql]: /integrations/:currentVersion:/psql/ -[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-view [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor [hypertables]: /use-timescale/:currentVersion:/hypertables/#hypertable-partitioning [hypertable-create-table]: /api/:currentVersion:/hypertable/create_table/ diff --git a/_partials/_create-service.md b/_partials/_create-service.md index ea550404f0..8970bdc71e 100644 --- a/_partials/_create-service.md +++ b/_partials/_create-service.md @@ -15,8 +15,5 @@ -You can [manage, pause, or delete][service-management] your $SERVICE_SHORT at any time from $CONSOLE. - [create-service]: https://console.cloud.timescale.com/dashboard/create_services [connect-to-your-service]: /getting-started/:currentVersion:/services/#connect-to-your-service -[service-management]: /use-timescale/:currentVersion:/services/service-management/ diff --git a/_partials/_foreign-data-wrappers.md b/_partials/_foreign-data-wrappers.md index 64dfaa7ae8..9b872314fc 100644 --- a/_partials/_foreign-data-wrappers.md +++ b/_partials/_foreign-data-wrappers.md @@ -189,7 +189,7 @@ You create $PG FDWs with the `postgres_fdw` extension. See [documenation][enable [vpc-peering]: /use-timescale/:currentVersion:/security/vpc/ -[sql-editor]: /getting-started/:currentVersion:/run-queries-from-console/#ops-mode-sql-editor/ +[sql-editor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor/ [connect]: /getting-started/:currentVersion:/run-queries-from-console/ [connection-info]: /integrations/:currentVersion:/find-connection-details/ [enable-fdw-docs]: https://www.postgresql.org/docs/current/postgres-fdw.html diff --git a/_partials/_import-data-iot.md b/_partials/_import-data-iot.md index 314265b44d..4b79c9c16f 100644 --- a/_partials/_import-data-iot.md +++ b/_partials/_import-data-iot.md @@ -53,7 +53,7 @@ import HypertableIntro from "versionContent/_partials/_tutorials_hypertable_intr You query $HYPERTABLEs in exactly the same way as you would a relational $PG table. Use one of the following SQL editors to run a query and see the data you uploaded: - - **Data mode**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. + - **$DATA_MODE**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. - **SQL editor**: write, fix, and organize SQL faster and more accurately in [$CONSOLE][portal-ops-mode] for a $SERVICE_LONG. - **psql**: easily run queries on your $SERVICE_LONGs or $SELF_LONG deployment from Terminal. @@ -77,7 +77,7 @@ import HypertableIntro from "versionContent/_partials/_tutorials_hypertable_intr [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql [connection-info]: /integrations/:currentVersion:/find-connection-details/ [migrate-with-downtime]: /migrate/:currentVersion:/pg-dump-and-restore/ [migrate-live]: /migrate/:currentVersion:/live-migration/ diff --git a/_partials/_import-data-nyc-taxis.md b/_partials/_import-data-nyc-taxis.md index abf586643a..11e4d230e9 100644 --- a/_partials/_import-data-nyc-taxis.md +++ b/_partials/_import-data-nyc-taxis.md @@ -115,7 +115,7 @@ import HypertableIntro from "versionContent/_partials/_tutorials_hypertable_intr You query $HYPERTABLEs in exactly the same way as you would a relational $PG table. Use one of the following SQL editors to run a query and see the data you uploaded: - - **Data mode**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. + - **$DATA_MODE**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. - **SQL editor**: write, fix, and organize SQL faster and more accurately in [$CONSOLE][portal-ops-mode] for a $SERVICE_LONG. - **psql**: easily run queries on your $SERVICE_LONGs or $SELF_LONG deployment from Terminal. @@ -165,7 +165,7 @@ import HypertableIntro from "versionContent/_partials/_tutorials_hypertable_intr [hypertables-section]: /use-timescale/:currentVersion:/hypertables/ [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql [connection-info]: /integrations/:currentVersion:/find-connection-details/ [migrate-with-downtime]: /migrate/:currentVersion:/pg-dump-and-restore/ [migrate-live]: /migrate/:currentVersion:/live-migration/ diff --git a/_partials/_service-overview-azure.md b/_partials/_service-overview-azure.md deleted file mode 100644 index 1035dc4ef8..0000000000 --- a/_partials/_service-overview-azure.md +++ /dev/null @@ -1,11 +0,0 @@ -import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-free-plan.mdx"; - -You manage your $SERVICE_LONGs and interact with your data in $CONSOLE using the following modes: - -| **$OPS_MODE_CAP** | **$DATA_MODE_CAP** | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ![$CONSOLE $OPS_MODE][ops-mode] | ![$CONSOLE $DATA_MODE][data-mode] | -| **You use the $OPS_MODE to:** | **Powered by $POPSQL, you use the $DATA_MODE to:** | - -[ops-mode]: https://assets.timescale.com/docs/images/tiger-on-azure/ops-mode-overview-tiger-cloud-console.png -[data-mode]: https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode.png \ No newline at end of file diff --git a/_partials/_service-overview.md b/_partials/_service-overview.md deleted file mode 100644 index f21c353256..0000000000 --- a/_partials/_service-overview.md +++ /dev/null @@ -1,11 +0,0 @@ -import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-free-plan.mdx"; - -You manage your $SERVICE_LONGs and interact with your data in $CONSOLE using the following modes: - -| **$OPS_MODE_CAP** | **$DATA_MODE_CAP** | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ![$CONSOLE $OPS_MODE][ops-mode] | ![$CONSOLE $DATA_MODE][data-mode] | -| **You use the $OPS_MODE to:** | **Powered by $POPSQL, you use the $DATA_MODE to:** | - -[ops-mode]: https://assets.timescale.com/docs/images/tiger-on-azure/ops-mode-overview-tiger-console.png -[data-mode]: https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode.png \ No newline at end of file diff --git a/_partials/_services-intro-azure.mdx b/_partials/_services-intro-azure.md similarity index 94% rename from _partials/_services-intro-azure.mdx rename to _partials/_services-intro-azure.md index 8dff84aaff..2e45ff1921 100644 --- a/_partials/_services-intro-azure.mdx +++ b/_partials/_services-intro-azure.md @@ -35,6 +35,8 @@ To the $PG you know and love, $CLOUD_LONG adds the following capabilities: Free $SERVICE_SHORTs offer limited resources and a basic feature scope, perfect to get to know $CLOUD_LONG in a development environment. +You can [manage, pause, or delete][service-management] your $SERVICE_SHORT at any time from $CONSOLE. + [what-is-time-series]: https://www.timescale.com/blog/time-series-database-an-explainer#what-is-a-time-series-database [create-service]: /getting-started/:currentVersion:/services/ [live-migration]: /migrate/:currentVersion:/live-migration/ @@ -50,4 +52,5 @@ To the $PG you know and love, $CLOUD_LONG adds the following capabilities: [insights]: /use-timescale/:currentVersion:/metrics-logging/monitoring/#insights [maintain-upgrade]: /use-timescale/:currentVersion:/upgrades/ [pricing-plans]: /about/:currentVersion:/pricing-and-account-management/ -[rbac]: /use-timescale/:currentVersion:/security/members/ \ No newline at end of file +[rbac]: /use-timescale/:currentVersion:/security/members/ +[service-management]: /use-timescale/:currentVersion:/services/service-management/ \ No newline at end of file diff --git a/_partials/_services-intro.md b/_partials/_services-intro.md index f7e5fbd5a4..3eeb4279fb 100644 --- a/_partials/_services-intro.md +++ b/_partials/_services-intro.md @@ -35,6 +35,8 @@ To the $PG you know and love, $CLOUD_LONG adds the following capabilities: Free $SERVICE_SHORTs offer limited resources and a basic feature scope, perfect to get to know $CLOUD_LONG in a development environment. +You can [manage, pause, or delete][service-management] your $SERVICE_SHORT at any time from $CONSOLE. + [what-is-time-series]: https://www.timescale.com/blog/time-series-database-an-explainer#what-is-a-time-series-database [create-service]: /getting-started/:currentVersion:/services/ [live-migration]: /migrate/:currentVersion:/live-migration/ @@ -50,4 +52,5 @@ To the $PG you know and love, $CLOUD_LONG adds the following capabilities: [insights]: /use-timescale/:currentVersion:/metrics-logging/monitoring/#insights [maintain-upgrade]: /use-timescale/:currentVersion:/upgrades/ [pricing-plans]: /about/:currentVersion:/pricing-and-account-management/ -[rbac]: /use-timescale/:currentVersion:/security/members/ \ No newline at end of file +[rbac]: /use-timescale/:currentVersion:/security/members/ +[service-management]: /use-timescale/:currentVersion:/services/ \ No newline at end of file diff --git a/about/changelog.md b/about/changelog.md index 39e734584a..7bbfcd5404 100644 --- a/about/changelog.md +++ b/about/changelog.md @@ -511,7 +511,7 @@ Data mode's [SQL assistant](https://docs.timescale.com/getting-started/latest/ru ### VPC support for passwordless data mode connections -We previously made it much easier to connect newly created services to Timescale’s [data mode](https://docs.timescale.com/getting-started/latest/run-queries-from-console/#data-mode). We have now expanded this functionality to services using a VPC. +We previously made it much easier to connect newly created services to Timescale's [data mode](https://docs.timescale.com/getting-started/latest/run-queries-from-console/#data-view). We have now expanded this functionality to services using a VPC. ## 🕵🏻️ Enhanced service monitoring, TimescaleDB v2.20, and livesync for $PG diff --git a/getting-started/run-queries-from-console.md b/getting-started/run-queries-from-console.md index 05ca600f43..1b211c9c35 100644 --- a/getting-started/run-queries-from-console.md +++ b/getting-started/run-queries-from-console.md @@ -1,6 +1,6 @@ --- title: Run your queries from Tiger Cloud Console -excerpt: Choose the right tool to manage your data. Tiger Cloud on AWS and Tiger Cloud on Azure offer the data mode, the SQL editor, and the SQL Assistant to better address your needs +excerpt: Choose the right tool to manage your data. Tiger Cloud on AWS and Tiger Cloud on Azure offer Data view, SQL editor, and SQL Assistant to better address your needs products: [cloud] content_group: Getting started --- @@ -15,30 +15,36 @@ connect to your $SERVICE_SHORT and interact with your data. In $CONSOLE you can use the following ways to run SQL queries against your $SERVICE_SHORT: -- [$DATA_MODE_CAP][run-popsql]: a rich experience powered by $POPSQL. You can write queries with +- [$DATA_MODE][run-popsql]: a rich experience powered by $POPSQL. You can write queries with autocomplete, save them in folders, share them, create charts/dashboards, and much more. -- [$SQL_ASSISTANT_SHORT in the $DATA_MODE][sql-assistant]: write, fix, and organize SQL faster and more accurately. +- [$SQL_ASSISTANT_SHORT in $DATA_MODE][sql-assistant]: write, fix, and organize SQL faster and more accurately. -- [$SQL_EDITOR in the $OPS_MODE][run-sqleditor]: a simple $SQL_EDITOR in the $OPS_MODE that lets you run ad-hoc ephemeral +- [$SQL_EDITOR][run-sqleditor]: a simple $SQL_EDITOR that lets you run ad-hoc ephemeral queries. This is useful for quick one-off tasks like creating an index on a small table or inspecting `pg_stat_statements`. -If you prefer the command line to the $OPS_MODE $SQL_EDITOR in $CONSOLE, use [psql][install-psql]. +If you prefer the command line to $CONSOLE editors, use [psql][install-psql]. -## Data mode +## $DATA_MODE -You use the $DATA_MODE in $CONSOLE to write queries, visualize data, and share your results. +You use $DATA_MODE in $CONSOLE to write queries, visualize data, and share your results. ![$CONSOLE $DATA_MODE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode.png) +To start using $DATA_MODE, open $CONSOLE and click `Data view`. This includes the following tabs: + +- **Files**: browse all your personal and shared queries, dashboards, notebooks, and folders. +- **Schemas**: view the schemas in your $SERVICE_SHORT. +- **dbt**: [create dbt macros and models][popsql-dbt]. +- **$SQL_ASSISTANT_SHORT**: [write, fix, and organize SQL][sql-assistant] faster and more accurately using AI. + Available features are: -- **Real-time collaboration**: work with your team directly in the $DATA_MODE query editor with live presence and multiple - cursors. +- **Real-time collaboration**: work with your team directly in $DATA_MODE with live presence and multiple + cursors. - **[Schema browser][schema-browser]**: understand the structure of your $SERVICE_SHORT and see usage data on tables and columns. -- **[$SQL_ASSISTANT_SHORT][sql-assistant]**: write, fix, and organize SQL faster and more accurately using AI. - **Autocomplete**: get suggestions as you type your queries. - **[Version history][version-history]**: access previous versions of a query from the built-in revision history, or connect to a git repo. - **[Charts][charts]**: visualize data from inside the UI rather than switch to Sheets or Excel. @@ -47,12 +53,10 @@ Available features are: - **Cross-platform support**: work from [$CONSOLE][portal-data-mode] or download the [desktop app][popsql-desktop] for macOS, Windows, and Linux. - **Easy connection**: connect to $CLOUD_LONG, $PG, Redshift, Snowflake, BigQuery, MySQL, SQL Server, [and more][popsql-connections]. -### Connect to your $SERVICE_LONG in the data mode +To connect to a $SERVICE_SHORT in $DATA_MODE: -To connect to a $SERVICE_SHORT: - 1. **Check your $SERVICE_SHORT is running correctly** In [$CONSOLE][services-portal], check that your $SERVICE_SHORT is marked as `Running`: @@ -61,7 +65,7 @@ To connect to a $SERVICE_SHORT: 1. **Connect to your $SERVICE_SHORT** - In the [$DATA_MODE][portal-data-mode] in $CONSOLE, select a $SERVICE_SHORT in the connection drop-down: + Click [`Data view`][portal-data-mode] in $CONSOLE, then select a $SERVICE_SHORT in the connection drop-down: ![Select a connection](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode-connection-dropdown.png) @@ -72,13 +76,13 @@ To connect to a $SERVICE_SHORT: ![Run a simple query](https://assets.timescale.com/docs/images/tiger-cloud-console/run-query-in-scratchpad-tiger-console.png) Quick recap. You: -- Manage your $SERVICE_SHORTs in the [$OPS_MODE in $CONSOLE][portal-ops-mode] -- Manage your data in the [$DATA_MODE in $CONSOLE][portal-data-mode] +- Manage your $SERVICE_SHORTs in [$CONSOLE][portal-ops-mode] +- Manage your data in [$DATA_MODE in $CONSOLE][portal-data-mode] - Store configuration and security information in your config file. -Now you have used the $DATA_MODE in $CONSOLE, see how to easily do the following: +Now you have used $DATA_MODE in $CONSOLE, see how to easily do the following: - [Write a query][write-query] - [Share a query with your teammates][share-query] @@ -86,43 +90,11 @@ Now you have used the $DATA_MODE in $CONSOLE, see how to easily do the following - [Create a dashboard of multiple query results][create-dashboard] - [Create schedules for your queries][create-schedule] -### Data mode FAQ - -#### What if my service is within a vpc? - -If your $SERVICE_LONG runs inside a $VPC, do one of the following to enable access for the $POPSQL desktop app: - -- Use $POPSQL's [bridge connector][bridge-connector]. -- Use an SSH tunnel: when you configure the connection in $POPSQL, under `Advanced Options` enable `Connect over SSH`. -- Add $POPSQL's static IPs (`23.20.131.72, 54.211.234.135`) to your allowlist. - -#### What happens if another member of my $PROJECT_LONG uses the $DATA_MODE? +### $SQL_ASSISTANT_SHORT -The number of $DATA_MODE seats you are allocated depends on your [$PRICING_PLAN][pricing-plan-features]. - -#### Will using the $DATA_MODE affect the performance of my $SERVICE_LONG? +$SQL_ASSISTANT_SHORT in [$DATA_MODE][portal-data-mode] is a chat-like interface that harnesses the power of AI to help you write, fix, and organize SQL faster and more accurately. Ask $SQL_ASSISTANT_SHORT to change existing queries, write new ones from scratch, debug error messages, optimize for query performance, add comments, improve readability—and really, get answers to any questions you can think of. -There are a few factors to consider: - -1. What instance size is your $SERVICE_SHORT? -1. How many users are running queries? -1. How computationally intensive are the queries? - -If you have a small number of users running performant SQL queries against a -$SERVICE_SHORT with sufficient resources, then there should be no degradation to -performance. However, if you have a large number of users running queries, or if -the queries are computationally expensive, best practice is to create -a [$READ_REPLICA][read-replica] and send analytical queries there. - -If you'd like to prevent write operations such as insert or update, instead -of using the `tsdbadmin` user, create a read-only user for your $SERVICE_SHORT and -use that in the $DATA_MODE. - -## $SQL_ASSISTANT_SHORT - -$SQL_ASSISTANT_SHORT in [$CONSOLE][portal-data-mode] is a chat-like interface that harnesses the power of AI to help you write, fix, and organize SQL faster and more accurately. Ask $SQL_ASSISTANT_SHORT to change existing queries, write new ones from scratch, debug error messages, optimize for query performance, add comments, improve readability—and really, get answers to any questions you can think of. - - +![$SQL_ASSISTANT](https://assets.timescale.com/docs/images/tiger-cloud-console/sql-assistant-in-action.png) -### Key capabilities +#### Key capabilities $SQL_ASSISTANT_SHORT offers a range of features to improve your SQL workflow, including: @@ -151,7 +123,7 @@ $SQL_ASSISTANT_SHORT offers a range of features to improve your SQL workflow, in - **Agent mode**: to get results with minimal involvement from you, $SQL_ASSISTANT_SHORT autopilots through complex tasks and troubleshoots its own problems. No need to go step by step, analyze errors, and try out solutions. Simply turn on the agent mode in the LLM picker and watch $SQL_ASSISTANT_SHORT do all the work for you. Recommended for use when your database connection is configured with read-only credentials. -### Supported LLMs +#### Supported LLMs $SQL_ASSISTANT_SHORT supports a large number of LLMs, including: @@ -184,7 +156,7 @@ $SQL_ASSISTANT_SHORT supports a large number of LLMs, including: Choose the LLM based on the particular task at hand. For simpler tasks, try the smaller and faster models like Gemini Flash, Haiku, or o4-mini. For more complex tasks, try the larger reasoning models like Claude Sonnet, Gemini Pro, or o3. We provide a description of each model to help you decide. -### Limitations to keep in mind +#### Limitations to keep in mind For best results with $SQL_ASSISTANT_SHORT: @@ -193,10 +165,10 @@ For best results with $SQL_ASSISTANT_SHORT: * **Business logic**: $SQL_ASSISTANT_SHORT does not inherently know specific business terms such as active user. Define these terms clearly to improve results. -### Security, privacy, and data usage +#### Security, privacy, and data usage Security and privacy is prioritized in $CONSOLE. In [$DATA_MODE][portal-data-mode], $PROJECT_SHORT members -manage $SQL_ASSISTANT_SHORT settings under [`User name` > `Settings` > `SQL Assistant`][sql-editor-settings]. +manage $SQL_ASSISTANT_SHORT settings under [`Preferences` > `SQL Assistant`][sql-editor-settings]. ![SQL assistant settings](https://assets.timescale.com/docs/images/tiger-console-sql-editor-preferences.png) @@ -208,7 +180,40 @@ $SQL_ASSISTANT_SHORT settings are: * **Sample data**: to give the LLM more context so you have better SQL suggestions, enable sample data sharing in the $SQL_ASSISTANT_SHORT preferences. * **Telemetry**: to improve $SQL_ASSISTANT_SHORT, $COMPANY collects telemetry and usage data, including prompts, responses, and query metadata. -## $OPS_MODE_CAP $SQL_EDITOR +### $DATA_MODE FAQ + +#### What if my service is within a vpc? + +If your $SERVICE_LONG runs inside a $VPC, do one of the following to enable access for the $POPSQL desktop app: + +- Use $POPSQL's [bridge connector][bridge-connector]. +- Use an SSH tunnel: when you configure the connection in $POPSQL, under `Advanced Options` enable `Connect over SSH`. +- Add $POPSQL's static IPs (`23.20.131.72, 54.211.234.135`) to your allowlist. + +#### What happens if another member of my $PROJECT_LONG uses $DATA_MODE? + +The number of $DATA_MODE seats you are allocated depends on your [$PRICING_PLAN][pricing-plan-features]. + +#### Will using $DATA_MODE affect the performance of my $SERVICE_LONG? + +There are a few factors to consider: + +1. What instance size is your $SERVICE_SHORT? +1. How many users are running queries? +1. How computationally intensive are the queries? + +If you have a small number of users running performant SQL queries against a +$SERVICE_SHORT with sufficient resources, then there should be no degradation to +performance. However, if you have a large number of users running queries, or if +the queries are computationally expensive, best practice is to create +a [$READ_REPLICA][read-replica] and send analytical queries there. + +If you'd like to prevent write operations such as insert or update, instead +of using the `tsdbadmin` user, create a read-only user for your $SERVICE_SHORT and +use that in $DATA_MODE. + + +## $SQL_EDITOR $SQL_EDITOR is an integrated secure UI that you use to run queries and see the results for a $SERVICE_LONG. @@ -224,7 +229,7 @@ To use $SQL_EDITOR: 1. **Open $SQL_EDITOR from $CONSOLE** - In the [$OPS_MODE][portal-ops-mode] in $CONSOLE, select a $SERVICE_SHORT, then click `SQL editor`. + In $CONSOLE, select a $SERVICE_SHORT, then click `SQL editor`. ![Check $SERVICE_SHORT is running](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-ops-mode-sql-editor-empty.png) @@ -238,8 +243,8 @@ To use $SQL_EDITOR: ## Cloud $SQL_EDITOR licenses -* **$SQL_EDITOR in the $OPS_MODE**: free for anyone with a [$ACCOUNT_LONG][create-cloud-account]. -* **Data mode**: the number of seats you are allocated depends on your [$PRICING_PLAN][pricing-plan-features]. +* **$SQL_EDITOR**: free for anyone with a [$ACCOUNT_LONG][create-cloud-account]. +* **$DATA_MODE**: the number of seats you are allocated depends on your [$PRICING_PLAN][pricing-plan-features]. [$SQL_ASSISTANT_SHORT][sql-assistant] is currently free for all users. In the future, limits or paid options may be introduced as we work to build the best experience. @@ -260,14 +265,14 @@ To use $SQL_EDITOR: [popsql-connections]: https://popsql.com/connections [popsql-desktop]: https://popsql.com/download [popsql-pricing]: https://popsql.com/pricing -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services [pricing-plan-features]: https://www.timescale.com/pricing#features [project-members]: /use-timescale/:currentVersion:/security/members/ [query-variables]: https://docs.popsql.com/docs/query-variables [read-replica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/ -[run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode -[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#ops-mode-sql-editor +[run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-view +[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor [schedules]: https://docs.popsql.com/docs/scheduled-queries [schema-browser]: https://docs.popsql.com/docs/schema [services-portal]: https://console.cloud.timescale.com/dashboard/services @@ -277,3 +282,4 @@ To use $SQL_EDITOR: [timescale-console]: https://console.cloud.timescale.com/ [version-history]: https://docs.popsql.com/docs/version-history [write-query]: https://docs.popsql.com/docs/writing-a-query +[popsql-dbt]: https://popsql.com/dbt \ No newline at end of file diff --git a/getting-started/services.md b/getting-started/services.md index 0ee8fe5bdb..e5d677e943 100644 --- a/getting-started/services.md +++ b/getting-started/services.md @@ -7,7 +7,6 @@ content_group: Getting started import CloudIntro from "versionContent/_partials/_cloud-intro.mdx"; import ServiceIntro from "versionContent/_partials/_services-intro.mdx"; -import ServiceOverview from "versionContent/_partials/_service-overview.mdx"; import StartUsingCloud from "versionContent/_partials/_start-using-cloud.mdx"; import Install from "versionContent/_partials/_cloud-installation.mdx"; import CreateService from "versionContent/_partials/_create-service.mdx"; @@ -16,7 +15,6 @@ import WhereNext from "versionContent/_partials/_where-to-next.mdx"; import InstallAzure from "versionContent/_partials/_cloud-installation-azure.mdx"; import ServiceIntroAzure from "versionContent/_partials/_services-intro-azure.mdx"; -import ServiceOverviewAzure from "versionContent/_partials/_service-overview-azure.mdx"; import StartUsingCloudAzure from "versionContent/_partials/_start-using-cloud-azure.mdx"; # Create a $SERVICE_LONG @@ -31,8 +29,6 @@ import StartUsingCloudAzure from "versionContent/_partials/_start-using-cloud-az - - ## Create a $ACCOUNT_LONG @@ -63,8 +59,6 @@ To run queries and perform other operations, connect to your $SERVICE_SHORT: - - ## Create a $ACCOUNT_LONG @@ -101,4 +95,4 @@ To run queries and perform other operations, connect to your $SERVICE_SHORT: [what-is-dynamic-postgres]: https://www.timescale.com/dynamic-postgresql [hypertables]: /use-timescale/:currentVersion:/hypertables/#hypertable-partitioning [timescaledb]: https://www.tigerdata.com/docs/#TimescaleDB -[pricing-plans]: /about/:currentVersion:/pricing-and-account-management/ \ No newline at end of file +[pricing-plans]: /about/:currentVersion:/pricing-and-account-management/ diff --git a/getting-started/try-key-features-timescale-products.md b/getting-started/try-key-features-timescale-products.md index d3a21d7c3e..5c9be6f306 100644 --- a/getting-started/try-key-features-timescale-products.md +++ b/getting-started/try-key-features-timescale-products.md @@ -167,8 +167,8 @@ relational and time-series data from external files. You query $HYPERTABLEs in exactly the same way as you would a relational $PG table. Use one of the following SQL editors to run a query and see the data you uploaded: - - **Data mode**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. - - **SQL editor**: write, fix, and organize SQL faster and more accurately in [$CONSOLE][portal-ops-mode] for a $SERVICE_LONG. + - **$DATA_MODE**: write queries, visualize data, and share your results in [$CONSOLE][portal-data-mode] for all your $SERVICE_LONGs. + - **$SQL_EDITOR**: write, fix, and organize SQL faster and more accurately in [$CONSOLE][portal-ops-mode] for a $SERVICE_LONG. - **psql**: easily run queries on your $SERVICE_LONGs or self-hosted $TIMESCALE_DB deployment from Terminal. @@ -200,22 +200,24 @@ $CONSOLE. You can also do this using psql. - + +1. **In $CONSOLE, click `Data view`** + 1. **Connect to your $SERVICE_SHORT** - In [$CONSOLE][portal-data-mode], select your $SERVICE_SHORT in the connection drop-down in the top right. + In the connection drop-down in the top right, select your $SERVICE_SHORT. 1. **Create a $CAGG** For a $CAGG, data grouped using a $TIME_BUCKET is stored in a $PG `MATERIALIZED VIEW` in a $HYPERTABLE. `timescaledb.continuous` ensures that this data is always up to date. - In data mode, use the following code to create a $CAGG on the real-time data in + In $DATA_MODE, use the following code to create a $CAGG on the real-time data in the `crypto_ticks` table: ```sql @@ -328,7 +330,7 @@ To set up data tiering: 1. **Set the time interval when data is tiered** - In $CONSOLE, click `Data` to switch to the data mode, then enable data tiering on a $HYPERTABLE with the following query: + In $CONSOLE, click `Data view`, then enable data tiering on a $HYPERTABLE with the following query: ```sql SELECT add_tiering_policy('assets_candlestick_daily', INTERVAL '3 weeks'); ``` @@ -387,7 +389,7 @@ What next? See the [use case tutorials][tutorials], interact with the data in yo [deploy-self-hosted]: /self-hosted/:currentVersion:/install/ [connect-to-your-service]: /getting-started/:currentVersion:/run-queries-from-console/ [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql [migrate-with-downtime]: /migrate/:currentVersion:/pg-dump-and-restore/ [migrate-live]: /migrate/:currentVersion:/live-migration/ [data-ingest]: /use-timescale/:currentVersion:/ingest-data/ diff --git a/integrations/find-connection-details.md b/integrations/find-connection-details.md index eccfbd5f4e..a30659ad01 100644 --- a/integrations/find-connection-details.md +++ b/integrations/find-connection-details.md @@ -43,7 +43,8 @@ To retrieve the connection details for your $PROJECT_LONG and $SERVICE_LONG: 1. **Retrieve your project ID**: - In [$CONSOLE][console-services], click your project name in the upper left corner, then click `Copy` next to the project ID. + In [$CONSOLE][console-services], click the arrows next to the project name in the top left. The project ID is under the project name. + ![Retrive the project id in $CONSOLE](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-project-id.png) 1. **Retrieve your service ID**: @@ -64,32 +65,7 @@ such as Terraform or the [$CLOUD_LONG REST API][rest-api-reference]: 1. **Open the settings for your project**: - In [$CONSOLE][console-services], click your project name in the upper left corner, then click `Project settings`. - -1. **Create client credentials**: - - 1. Click `Create credentials`, then copy `Public key` and `Secret key` locally. - - ![Retrive the service id in $CONSOLE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-cloud-console-client-credentials.png) - - This is the only time you see the `Secret key`. After this, only the `Public key` is visible in this page. - - 1. Click `Done`. - - - -## Create client credentials - -You use client credentials to obtain access tokens outside of the user context. - -To retrieve the connection details for your $CLOUD_LONG project for programmatic usage -such as Terraform or the [$CLOUD_LONG REST API][rest-api-reference]: - - - -1. **Open the settings for your project**: - - In [$CONSOLE][console-services], click your project name in the upper left corner, then click `Project settings`. + In [$CONSOLE][console-services], click `Settings`. 1. **Create client credentials**: diff --git a/integrations/fivetran.md b/integrations/fivetran.md index c2ad269f8f..2be779d992 100644 --- a/integrations/fivetran.md +++ b/integrations/fivetran.md @@ -51,15 +51,15 @@ $SERVICE_LONG. This section shows you how to inject the logs for your Fivetran c -1. In [Fivetran Dashboard > Connections][fivetran-dashboard-connectors], click `Add connector`. -1. Search for the `Fivetran Platform` connector, then click `Setup`. +1. In [Fivetran Dashboard > Connections][fivetran-dashboard-connectors], click `Add connection`. +1. Search for the `Fivetran Platform` connector, then click `Set up`. 1. Leave the default schema name, then click `Save & Test`. You see `All connection tests passed!` -1. Click `Continue`, enable `Add Quickstart Data Model` and click `Continue`. +1. Click `Continue`, select `Yes, build data models for me`, and click `Continue`. Your Fivetran connection is connected to your $SERVICE_LONG destination. -1. Click `Start Initial Sync`. +1. Select `Start syncing all my data now` and click `Start initial sync`. Fivetran creates the log schema in your $SERVICE_SHORT and syncs the data to your $SERVICE_SHORT. @@ -71,7 +71,7 @@ To see data injected by Fivetran into your $SERVICE_LONG: -1. In [data mode][portal-data-mode] in $CONSOLE, select your $SERVICE_SHORT, then run the following query: +1. In $CONSOLE, click `Data view`, select your $SERVICE_SHORT, then run the following query: ```sql SELECT * FROM fivetran_log.account @@ -90,4 +90,4 @@ You have successfully integrated Fivetran with $CLOUD_LONG. [sign-up-fivetran]: https://www.fivetran.com/ [fivetran-dashboard-destinations]: https://fivetran.com/dashboard/destinations [fivetran-dashboard-connectors]: https://fivetran.com/dashboard/connections -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/data-view?popsql diff --git a/integrations/terraform.md b/integrations/terraform.md index ec052e6291..ccf6e4f6e0 100644 --- a/integrations/terraform.md +++ b/integrations/terraform.md @@ -26,17 +26,13 @@ Configure Terraform based on your deployment type: - + You use the [$COMPANY Terraform provider][terraform-provider] to manage $SERVICE_LONGs: -1. **Generate client credentials for programmatic use** - - 1. In [$CONSOLE][console], click `Projects` and save your `Project ID`, then click `Project settings`. - - 1. Click `Create credentials`, then save `Public key` and `Secret key`. +1. **[Generate client credentials][generate-credentials]** 1. **Configure $COMPANY Terraform provider** @@ -151,3 +147,4 @@ You can now manage your database with Terraform. [terraform-resources]: https://registry.terraform.io/providers/timescale/timescale/latest/docs/resources/peering_connection [terraform-data-sources]: https://registry.terraform.io/providers/timescale/timescale/latest/docs/data-sources/products [pg-provider]: https://registry.terraform.io/providers/cyrilgdn/postgresql/latest +[generate-credentials]: /integrations/:currentVersion:/find-connection-details/#create-client-credentials \ No newline at end of file diff --git a/lambda/redirects.js b/lambda/redirects.js index a37d3936a1..78c2631c13 100644 --- a/lambda/redirects.js +++ b/lambda/redirects.js @@ -1118,5 +1118,9 @@ module.exports = [ { from: "/use-timescale/latest/ingest-data/", to: "https://www.tigerdata.com/docs/integrations/latest/#data-ingestion-and-streaming" + }, + { + from: "/getting-started/latest/run-queries-from-console/#data-mode", + to: "https://www.tigerdata.com/docs/getting-started/latest/run-queries-from-console/#data-view" } ]; diff --git a/migrate/livesync-for-s3.md b/migrate/livesync-for-s3.md index 562af90abc..ede21efbdc 100644 --- a/migrate/livesync-for-s3.md +++ b/migrate/livesync-for-s3.md @@ -28,7 +28,7 @@ You can use the $S3_CONNECTOR to synchronize your existing and new data. Here's - CSV: check for compression in GZ and ZIP format, then process using [timescaledb-parallel-copy][parallel-copy]. - Parquet: convert to CSV, then process using [timescaledb-parallel-copy][parallel-copy]. -* The $S3_CONNECTOR offers an option to enable a [$HYPERTABLE][about-hypertables] during the file-to-table schema mapping setup. You can enable [columnstore][compression] and [continuous aggregates][caggs] through the SQL editor once the connector has started running. +* The $S3_CONNECTOR offers an option to enable a [$HYPERTABLE][about-hypertables] during the file-to-table schema mapping setup. You can enable [columnstore][compression] and [continuous aggregates][caggs] through $SQL_EDITOR once the connector has started running. * The connector offers a default 1-minute polling interval. This means that $CLOUD_LONG checks the S3 source every minute for new data. You can customize this interval by setting up a cron expression. diff --git a/migrate/upload-file-using-console.md b/migrate/upload-file-using-console.md index 8fb713b2ba..a9655f3df1 100644 --- a/migrate/upload-file-using-console.md +++ b/migrate/upload-file-using-console.md @@ -214,4 +214,4 @@ And that is it, you have imported your data to your $SERVICE_LONG. [credentials-iam]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html#roles-creatingrole-user-console [credentials-public]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-anonymous-user -[console]: hhttps://console.cloud.timescale.com/dashboard/services +[console]: https://console.cloud.timescale.com/dashboard/services diff --git a/migrate/upload-file-using-terminal.md b/migrate/upload-file-using-terminal.md index b56a7ca410..13c36ce256 100644 --- a/migrate/upload-file-using-terminal.md +++ b/migrate/upload-file-using-terminal.md @@ -282,7 +282,7 @@ And that is it, you have imported your data from a Parquet file to your $SERVICE [apache-parquet]: https://parquet.apache.org/ [apache-parquet-file-format]: https://parquet.apache.org/docs/file-format/ -[data-mode]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +[data-mode]: /getting-started/:currentVersion:/run-queries-from-console/#data-view [hypertable-docs]: /use-timescale/:currentVersion:/hypertables/ [install-docker]: https://docs.docker.com/engine/install/ [install-duckdb]: https://duckdb.org/docs/installation/ diff --git a/use-timescale/configuration/customize-configuration.md b/use-timescale/configuration/customize-configuration.md index b525426a85..46c76029d5 100644 --- a/use-timescale/configuration/customize-configuration.md +++ b/use-timescale/configuration/customize-configuration.md @@ -44,7 +44,7 @@ outside of that field saves the value to be applied. Change Tiger Cloud configuration parameters ### Apply configuration changes @@ -57,9 +57,4 @@ case, the button reads `Apply changes and restart`. A confirmation dialog is displayed which indicates whether a restart is required. Click `Confirm` to apply the changes, and restart if necessary. - - [plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan \ No newline at end of file diff --git a/use-timescale/data-tiering/enabling-data-tiering.md b/use-timescale/data-tiering/enabling-data-tiering.md index ceb62e3b87..74f83f1d9e 100644 --- a/use-timescale/data-tiering/enabling-data-tiering.md +++ b/use-timescale/data-tiering/enabling-data-tiering.md @@ -118,7 +118,7 @@ older than the `move_after` threshold to the object storage tier. This works sim A tiering policy schedules a job that runs periodically to asynchronously migrate eligible chunks to object storage. Chunks are considered tiered once they appear in the `timescaledb_osm.tiered_chunks` view. -You can add tiering policies to [hypertables][hypertable], including [continuous aggregates][caggs]. To manage tiering policies, [connect to your service][connect-to-service] and run the queries below in the data mode, the SQL editor, or using `psql`. +You can add tiering policies to [hypertables][hypertable], including [continuous aggregates][caggs]. To manage tiering policies, [connect to your service][connect-to-service] and run the queries below in $DATA_MODE, $SQL_EDITOR, or using `psql`. #### Add a tiering policy @@ -154,7 +154,7 @@ If you remove a tiering policy, the remaining scheduled chunks are not tiered. H ### Manually tier and untier chunks -If tiering policies do not meet your current needs, you can tier and untier chunks manually. To do so, [connect to your $SERVICE_SHORT][connect-to-service] and run the queries below in the data mode, the SQL editor, or using `psql`. +If tiering policies do not meet your current needs, you can tier and untier chunks manually. To do so, [connect to your $SERVICE_SHORT][connect-to-service] and run the queries below in $DATA_MODE, $SQL_EDITOR, or using `psql`. #### Tier chunks diff --git a/use-timescale/page-index/page-index.js b/use-timescale/page-index/page-index.js index b1e18030f1..faaefdf736 100644 --- a/use-timescale/page-index/page-index.js +++ b/use-timescale/page-index/page-index.js @@ -137,9 +137,9 @@ module.exports = [ excerpt: "About Tiger Cloud services", children: [ { - title: "Services overview", + title: "Tiger Console overview", href: "service-overview", - excerpt: "Tiger Cloud services overview", + excerpt: "Tiger Console overview", }, { title: "Service explorer", diff --git a/use-timescale/query-data/about-query-data.md b/use-timescale/query-data/about-query-data.md index 0f16b79b1a..375cf8abfc 100644 --- a/use-timescale/query-data/about-query-data.md +++ b/use-timescale/query-data/about-query-data.md @@ -23,5 +23,5 @@ $TIMESCALE_DB also provides some additional features to help with data analysis: [hyperfunctions]: /use-timescale/:currentVersion:/hyperfunctions/ [pipelines]: /use-timescale/:currentVersion:/hyperfunctions/function-pipelines/ [skipscan]: /use-timescale/:currentVersion:/query-data/skipscan/ -[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-view [readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/ diff --git a/use-timescale/query-data/select.md b/use-timescale/query-data/select.md index cb14ca2713..95552fb9f2 100644 --- a/use-timescale/query-data/select.md +++ b/use-timescale/query-data/select.md @@ -66,5 +66,5 @@ SELECT COUNT(DISTINCT location) FROM conditions [postgres-select]: https://www.postgresql.org/docs/current/sql-select.html [time_bucket]: /use-timescale/:currentVersion:/time-buckets/ -[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-view diff --git a/use-timescale/security/client-credentials.md b/use-timescale/security/client-credentials.md index 60c0593e9c..87820a59d1 100644 --- a/use-timescale/security/client-credentials.md +++ b/use-timescale/security/client-credentials.md @@ -25,33 +25,27 @@ token programmatically, see the -### Creating client credentials - -1. [Log in to your $ACCOUNT_LONG][cloud-login]. -1. Navigate to the `Project Settings` page to create client credentials for - your $PROJECT_SHORT. -1. In the `Project Settings` page, click `Create credentials`. +1. Log in to [$CONSOLE][cloud-login] and click `Settings`. +1. Click `Create credentials`. 1. In the `New client credentials` dialog, you can view the `Public key` and the `Secret Key`. Copy your secret key and store it in a secure place. You won't be able to - view the `Secret Key` again in the console. + view the `Secret Key` again in $CONSOLE. 1. Click `Done`. You can use these keys in your client applications to access $CLOUD_LONG resources inside the respective $PROJECT_SHORT. $CLOUD_LONG generates a default `Name` for the client credentials. 1. Click the ⋮ menu and select `Rename credentials`. -1. In the `Edit credential name` dialog, type the new name and click `Accept`. +1. In the `Edit credential name` dialog, type the new name and click `Accept`. -### Deleting client credentials +## Delete client credentials -1. [Log in to your $ACCOUNT_LONG][cloud-login]. -1. Navigate to the `Project Settings` page to view client credentials for - your $PROJECT_SHORT. -1. In the `Project Settings` page, click the ⋮ menu of the client credential, +1. Log in to [$CONSOLE][cloud-login] and click `Settings`. +1. Click the `⋮` menu of the client credential, and select `Delete`. 1. In the `Are you sure` dialog, type the name of the client credential, and click `Delete`. diff --git a/use-timescale/security/ip-allow-list.md b/use-timescale/security/ip-allow-list.md index 057e8d7d68..2bfa501ef2 100644 --- a/use-timescale/security/ip-allow-list.md +++ b/use-timescale/security/ip-allow-list.md @@ -1,6 +1,6 @@ --- title: IP allow list -excerpt: You can grant selective access to your service administration and data. See how to create IP whitelists for the different modes available in Tiger Cloud Console +excerpt: You can grant selective access to your service administration and data. See how to create IP whitelists in Tiger Console products: [cloud] keywords: [ip allow list, security] tags: [ip allow list] @@ -10,9 +10,9 @@ tags: [ip allow list] You can restrict access to your $SERVICE_LONGs to trusted IP addresses only. This prevents unauthorized connections without the need for a [Virtual Private Cloud][vpc-peering]. Creating IP allow lists helps comply with security standards such as SOC 2 or HIPAA that require IP filtering. This is especially useful in regulated industries like finance, healthcare, and government. -For a more fine-grained control, you create separate IP allow lists for [the ops mode and the data mode][modes]. +For a more fine-grained control, you create separate IP allow lists for [service and data management][modes]. -## Create and attach an IP allow list in the ops mode +## Create and attach an IP allow list for service management You create an IP allow list at the [$PROJECT_SHORT level][members], then attach your $SERVICE_SHORT to it. @@ -46,17 +46,19 @@ You attach a $SERVICE_SHORT to either one $VPC, or one IP allow list. You cannot -You have created and attached an IP allow list for the operations available in the ops mode. You can unattach or change the list attached to a $SERVICE_SHORT from the same tab. +You have created and attached an IP allow list for service management operations. You can unattach or change the list attached to a $SERVICE_SHORT from the same tab. -## Create an IP allow list in the data mode +## Create an IP allow list for querying your data -You create an IP allow list in the data mode settings. +You create an IP allow list in the $DATA_MODE settings. -1. **In [$CONSOLE][console], toggle `Data`** +1. **In [$CONSOLE][console], click `Data view`** -1. **Click the $PROJECT_SHORT name in the upper left corner, then select `Settings`** +1. **Click the cog icon to open `Preferences` > `Settings`** + +1. **Log into PopSQL** 1. **Scroll down and toggle `IP Allowlist`** @@ -70,13 +72,13 @@ You create an IP allow list in the data mode settings. -You have successfully added an IP allow list for querying your $SERVICE_SHORT in the data mode. +You have successfully added an IP allow list for querying your $SERVICE_SHORT in $DATA_MODE. [console]: https://console.cloud.timescale.com/dashboard/ [pricing-plans]: /about/:currentVersion:/pricing-and-account-management/ [vpc-peering]: /use-timescale/:currentVersion:/security/vpc/ [members]: /use-timescale/:currentVersion:/security/members/ -[modes]: /getting-started/:currentVersion:/services/ +[modes]: /use-timescale/:currentVersion:/services/service-overview/ diff --git a/use-timescale/security/members.md b/use-timescale/security/members.md index 9277633ac1..a42cc3e8f2 100644 --- a/use-timescale/security/members.md +++ b/use-timescale/security/members.md @@ -20,7 +20,7 @@ This includes the following roles: - **Owner**: $CLOUD_LONG assigns this role to you when your $PROJECT_SHORT is created. As the Owner, you can add and delete other users, transfer project ownership, administer $SERVICE_SHORTs, and edit $PROJECT_SHORT settings. - **Admin**: the Owner assigns this role to other users in the $PROJECT_SHORT. A user with the Admin role has the same scope of rights as the Owner but cannot transfer project ownership. - **Developer**: the Owner and Admins assign this role to other users in the $PROJECT_SHORT. A Developer can build, deploy, and operate $SERVICE_SHORTs across projects, but does not have administrative privileges over users, roles, or billing. A Developer can invite other users to the $PROJECT_SHORT, but only with the Viewer role. -- **Viewer**: the Owner and Admins assign this role to other users in the $PROJECT_SHORT. A Viewer has limited, read-only access to $CONSOLE_LONG. This means that a Viewer cannot modify $SERVICE_SHORTs and their configurations in any way. A Viewer has no access to the $DATA_MODE and has read-queries-only access to $SQL_EDITOR. +- **Viewer**: the Owner and Admins assign this role to other users in the $PROJECT_SHORT. A Viewer has limited, read-only access to $CONSOLE_LONG. This means that a Viewer cannot modify $SERVICE_SHORTs and their configurations in any way. A Viewer has no access to $DATA_MODE and has read-queries-only access to $SQL_EDITOR. ![Project users in $CONSOLE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-project-roles-overview.png) @@ -43,7 +43,7 @@ To add a user to a $PROJECT_SHORT: -1. In [$CONSOLE][cloud-login], click `Invite users`, then click `Add new user`. +1. In [$CONSOLE][cloud-login], click `Users`, then click `Add new user`. 1. Type the email address of the person that you want to add, select their role, and click `Invite user`. @@ -112,7 +112,7 @@ $PROJECT_SHORT_CAP invitations are valid for 7 days. To resend a $PROJECT_SHORT -1. In [$CONSOLE][cloud-login], click `Invite users`. +1. In [$CONSOLE][cloud-login], click `Users`. 1. Next to the person you want to invite to your $PROJECT_SHORT, click `Resend invitation`. @@ -126,7 +126,7 @@ To change the $PROJECT_SHORT you are currently working in: -1. In [$CONSOLE][cloud-login], click the $PROJECT_SHORT name > `Current project` in the top left. +1. In [$CONSOLE][cloud-login], click the arrows next to the $PROJECT_SHORT name in the top left. ![Change project in $CONSOLE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-change-project.png) @@ -144,12 +144,10 @@ To transfer $PROJECT_SHORT ownership: -1. In [$CONSOLE][cloud-login], click `Invite users`. +1. In [$CONSOLE][cloud-login], click `Users`. 1. Next to the person you want to transfer project ownership to, click `⋮` > `Transfer project ownership`. - ![Transfer project ownership in $CONSOLE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-transfer-project-ownership.png) - If you are unable to transfer ownership, hover over the greyed out button to see the details. 1. Enter your password, and click `Verify`. @@ -167,7 +165,7 @@ To stop working in a $PROJECT_SHORT: -1. In [$CONSOLE][cloud-login], click `Invite users`. +1. In [$CONSOLE][cloud-login], click `Users`. 1. Click `⋮` > `Leave project`, then click `Leave`. @@ -183,7 +181,7 @@ To change the role for another user: -1. In [$CONSOLE][cloud-login], click `Invite users`. +1. In [$CONSOLE][cloud-login], click `Users`. 1. Next to the corresponding user, select another role in the dropdown. @@ -199,7 +197,7 @@ To remove a user's access to a $PROJECT_SHORT: -1. In [$CONSOLE][cloud-login], click `Invite users`. +1. In [$CONSOLE][cloud-login], click `Users`. 1. Next to the person you want to remove, click `⋮` > `Remove`. ![Remove user in $CONSOLE](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-transfer-project-ownership.png) 1. In `Remove user`, click `Remove`. diff --git a/use-timescale/security/multi-factor-authentication.md b/use-timescale/security/multi-factor-authentication.md index 92391c064b..9583d515d5 100644 --- a/use-timescale/security/multi-factor-authentication.md +++ b/use-timescale/security/multi-factor-authentication.md @@ -30,8 +30,8 @@ Take the following steps to configure two-factor authentication: 1. Log in to [$CONSOLE][cloud-login] with your username and password. 2FA is not available if you log in with Google SSO. -1. Click the `User name` icon in the bottom left of $CONSOLE and select `Account`. -1. In `Account`, click `Add two-factor authentication`. +1. Click your user name in the top right of $CONSOLE and select `Account settings`. +1. Click `Add two-factor authentication`. 1. On your mobile device, open Google Authenticator, tap `+`, and select `Scan a QR code`. 1. Scan the QR code provided by $CONSOLE in `Connect to an authenticator app` and click `Next`. @@ -62,11 +62,9 @@ recovery codes, or lost access to them, you can generate another list. Generatin 1. Log in to [$CONSOLE][cloud-login] with your username and password. -1. Click the `User name` icon in the bottom left and select `Account`. -1. In `Account`, navigate to `Two-factor authentication`. -1. Click `Regenerate recovery codes`. -1. In `Two-factor authentication`, enter the verification code from - your authenticator app. +1. Click your user name in the top right and select `Account settings`. +1. In `Two-factor authentication`, click `Regenerate recovery codes`. +1. Enter the verification code from your authenticator app. Alternatively, if you do not have access to the authenticator app, click `Use recovery code instead` to enter a recovery code. 1. Click `Next`. @@ -86,9 +84,8 @@ again with your new device. 1. Log in to [$CONSOLE][cloud-login] with your username and password. -1. Click the `User name` icon in the bottom left of $CONSOLE and select `Account`. -1. In `Account`, navigate to `Two-factor authentication`. -1. Click `Remove two-factor authentication`. +1. Click your user name in the top right of $CONSOLE and select `Account settings`. +1. In `Two-factor authentication`, click `Remove two-factor authentication`. 1. Enter the verification code from your authenticator app to confirm. Alternatively click `Use recovery code instead` to type the recovery code. 1. Click `Remove`. diff --git a/use-timescale/services/service-overview.md b/use-timescale/services/service-overview.md index 371ed4332b..8ab817b9a2 100644 --- a/use-timescale/services/service-overview.md +++ b/use-timescale/services/service-overview.md @@ -8,55 +8,57 @@ cloud_ui: path: - [services, :serviceId, overview] --- -import ServiceOverview from "versionContent/_partials/_service-overview.mdx"; -import ServiceOverviewAzure from "versionContent/_partials/_service-overview-azure.mdx"; -import ServiceUsers from "versionContent/_partials/_service-users.mdx"; -# About $SERVICE_LONGs +# $CONSOLE_LONG overview - +You use $CONSOLE_LONG to manage your $SERVICE_SHORTs and data in a convenient, centralized manner. When you [log into $CONSOLE][cloud-login], you see `Services` and other $PROJECT_SHORT management tabs: - +![Check $SERVICE_LONG is running](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-services-view.png) - +- `Services`: create a new [$SERVICE_SHORT][create-service] in your $PROJECT_SHORT, and view the existing $SERVICE_SHORTs and their statuses. Each $SERVICE_SHORT is an optimized [$PG][postgres-link] instance extended with database engine innovations such as [$TIMESCALE_DB][timescaledb-link], managed for you by $CLOUD_LONG. +- `Security`: create [$VPCs][vpc] and [IP allowlists][ip-allowlist]. +- `Exporters`: [export metrics and logs][metrics-logging] from your $SERVICE_SHORTs. +- `Activity`: [check your $SERVICE_SHORTs][activity-log] and $PROJECT_SHORT activity. +- `Settings`: [create client credentials][find-connection-info], add AI model API keys, and request a SOC 2 report. +- `Users`: [add and remove users][members] in your $PROJECT_SHORT. +- `Billing`: [check usage][check-usage], [change $PRICING_PLANs][pricing], and manage payment methods. +- `Data view`: [write queries with autocomplete][run-queries-data-view] for any $SERVICE_SHORT, save them in folders, share them, and create charts/dashboards with the added power of AI. -When you log into [$CONSOLE][cloud-login], you see the -$PROJECT_SHORT overview. Click a $SERVICE_SHORT to view run-time data and connection information. -Click `Operations` to configure your $SERVICE_SHORT. +When you select a $SERVICE_LONG in the `Services` tab, you see `Overview` and other $SERVICE_SHORT management tabs: ![Select a query to edit](https://assets.timescale.com/docs/images/tiger-on-azure/ops-mode-overview-tiger-console.png) -Each $SERVICE_SHORT hosts a single database managed for you by $CLOUD_LONG. -If you need more than one database, [create a new $SERVICE_SHORT][create-service]. - -## $SERVICE_SHORT_CAP users - - - - - - - - - -When you log into [$CONSOLE][cloud-login], you see the -$PROJECT_SHORT overview. Click a $SERVICE_SHORT to view run-time data and connection information. -Click `Operations` to configure your $SERVICE_SHORT. - -![Select a query to edit](https://assets.timescale.com/docs/images/tiger-on-azure/ops-mode-overview-tiger-console.png) - -Each $SERVICE_SHORT hosts a single database managed for you by $CLOUD_LONG. -If you need more than one database, [create a new $SERVICE_SHORT][create-service]. - -## $SERVICE_SHORT_CAP users - - - - - - +- `Overview`: get an overview of your $SERVICE_SHORT details, infrastructure, [connection info][connect-service], and [performance optimization tips][recommendations]. +- `Actions`: [connect and import data][import-sync] into your $SERVICE_SHORT. +- `Explorer`: [inspect objects and storage configuration][service-explorer] for your $SERVICE_SHORT. +- `Monitoring`: [get visibility][monitoring] into your $SERVICE_SHORT performance. +- `Connectors`: [sync or stream][import-sync] directly in your $SERVICE_SHORT, so data from another source is continuously updated. +- `SQL editor`: [query your $SERVICE_SHORTs][run-queries-sql-editor]. +- `Operations`: fully manage your $SERVICE_SHORT: [configure compute and storage][change-resources], [set up replicas][replication], [back up][backup], [upgrade][upgrade], and more. +- `AI`: create vector embeddings and [manage AI extensions][manage-extensions] for your $SERVICE_SHORT. [cloud-login]: https://console.cloud.timescale.com/ [pg-roles-doc]: https://www.postgresql.org/docs/current/role-attributes.html -[create-service]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-service - +[create-service]: /getting-started/:currentVersion:/services +[metrics-logging]: /use-timescale/:currentVersion:/metrics-logging/ +[members]: /use-timescale/:currentVersion:/security/members/ +[run-queries-data-view]: /getting-started/:currentVersion:/run-queries-from-console/#data-view +[run-queries-sql-editor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor +[service-explorer]: /use-timescale/:currentVersion:/services/service-explorer/ +[import-sync]: /migrate/:currentVersion:/ +[monitoring]: /use-timescale/:currentVersion:/metrics-logging/monitoring/ +[find-connection-info]: /integrations/:currentVersion:/find-connection-details/#create-client-credentials +[pricing]: /about/:currentVersion:/pricing-and-account-management/#upgrade-or-downgrade-your-pricing-plans-at-any-time +[check-usage]: /about/:currentVersion:/pricing-and-account-management/#monitor-usage-and-costs +[connect-service]: /getting-started/:currentVersion:/services/#connect-to-your-service +[recommendations]: /use-timescale/:currentVersion:/metrics-logging/monitoring/#recommendations +[change-resources]: /use-timescale/:currentVersion:/services//change-resources/ +[replication]: /use-timescale/:currentVersion:/ha-replicas/ +[backup]: /use-timescale/:currentVersion:/backup-restore/ +[upgrade]: /use-timescale/:currentVersion:/upgrades/ +[postgres-link]: /api/:currentVersion:/glossary/#postgresql +[timescaledb-link]: /api/:currentVersion:/glossary/#timescaledb +[vpc]: /use-timescale/:currentVersion:/security/vpc/ +[ip-allowlist]: /use-timescale/:currentVersion:/security/ip-allow-list/ +[manage-extensions]: /use-timescale/:currentVersion:/extensions/ +[activity-log]: /about/:currentVersion:/changelog#activity-log