Skip to content

Commit

Permalink
Direct more attention to CC
Browse files Browse the repository at this point in the history
- On CRDB install pages
- On local cluster pages

Also make secure the default for local cluster.
  • Loading branch information
jseldess committed Sep 9, 2020
1 parent cc1862a commit 7bc729d
Show file tree
Hide file tree
Showing 15 changed files with 36 additions and 25 deletions.
3 changes: 3 additions & 0 deletions _includes/cockroachcloud/use-cockroachcloud-instead.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{{site.data.alerts.callout_success}}
To deploy a 30-day free CockroachCloud cluster instead of running CockroachDB yourself, see the <a href="../cockroachcloud/quickstart.html">Quickstart</a>.
{{site.data.alerts.end}}
4 changes: 2 additions & 2 deletions _includes/sidebar-data-v20.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
{
"title": "From Binary",
"urls": [
"/${VERSION}/start-a-local-cluster.html",
"/${VERSION}/secure-a-cluster.html"
"/${VERSION}/secure-a-cluster.html",
"/${VERSION}/start-a-local-cluster.html"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions _includes/sidebar-data-v20.2.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
{
"title": "From Binary",
"urls": [
"/${VERSION}/start-a-local-cluster.html",
"/${VERSION}/secure-a-cluster.html"
"/${VERSION}/secure-a-cluster.html",
"/${VERSION}/start-a-local-cluster.html"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions cockroachcloud/create-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ redirect_from:

This page walks you through the process of creating a CockroachCloud cluster.

{{site.data.alerts.callout_info}}
To create and connect to a 30-day free CockroachCloud cluster and run your first query, see the [Quickstart guide](quickstart.html).
{{site.data.alerts.callout_success}}
To create and connect to a 30-day free CockroachCloud cluster and run your first query, see the [Quickstart](quickstart.html).
{{site.data.alerts.end}}

## Before you begin
Expand Down
2 changes: 1 addition & 1 deletion cockroachcloud/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:

This page shows you how to deploy a free CockroachDB cluster on CockroachCloud. You'll use a 30-day free trial code to create the cluster and a sample workload to connect and run your first query.

To run CockroachDB on your local machine instead, see [Start a Local Cluster](../stable/start-a-local-cluster.html).
To run CockroachDB on your local machine instead, see [Start a Local Cluster](../stable/secure-a-cluster.html).

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/install-cockroachdb-linux.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

<div id="download-the-binary-linux" class="install-option">
<h2>Download the Binary</h2>

Expand Down
2 changes: 2 additions & 0 deletions v20.1/install-cockroachdb-mac.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

<div id="use-homebrew" class="install-option">
<h2>Use Homebrew</h2>
<ol>
Expand Down
2 changes: 2 additions & 0 deletions v20.1/install-cockroachdb-windows.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

<div id="download-the-binary-windows" class="install-option">
<h2>Download the executable</h2>

Expand Down
7 changes: 3 additions & 4 deletions v20.1/secure-a-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@ asciicast: true
---

<div class="filters filters-big clearfix">
<a href="start-a-local-cluster.html"><button class="filter-button">Insecure</button></a>
<a href="secure-a-cluster.html"><button class="filter-button current"><strong>Secure</strong></button></a>
<a href="start-a-local-cluster.html"><button class="filter-button">Insecure</button></a>
</div>

Once you've [installed CockroachDB](install-cockroachdb.html), it's simple to run a secure multi-node cluster locally, using [TLS certificates](cockroach-cert.html) to encrypt network communication.

{{site.data.alerts.callout_info}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed CockroachDB](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down
7 changes: 3 additions & 4 deletions v20.1/start-a-local-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,19 @@ asciicast: true
---

<div class="filters filters-big clearfix">
<a href="start-a-local-cluster.html"><button class="filter-button current"><strong>Insecure</strong></button></a>
<a href="secure-a-cluster.html"><button class="filter-button">Secure</button></a>
<a href="start-a-local-cluster.html"><button class="filter-button current"><strong>Insecure</strong></button></a>
</div>

Once you've [installed CockroachDB](install-cockroachdb.html), it's simple to run an insecure multi-node cluster locally.

{{site.data.alerts.callout_info}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed CockroachDB](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: Update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down
2 changes: 2 additions & 0 deletions v20.2/install-cockroachdb-linux.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

{{site.data.alerts.callout_success}}
<span class="version-tag">New in v20.2</span>: For instructions showing how to install CockroachDB with support for storing and querying spatial data, see <a href="install-cockroachdb-spatial.html#linux">Install CockroachDB Spatial</a>.
{{site.data.alerts.end}}
Expand Down
2 changes: 2 additions & 0 deletions v20.2/install-cockroachdb-mac.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

{{site.data.alerts.callout_success}}
<span class="version-tag">New in v20.2</span>: For instructions showing how to install CockroachDB with support for storing and querying spatial data, see <a href="install-cockroachdb-spatial.html#mac">Install CockroachDB Spatial</a>.
{{site.data.alerts.end}}
Expand Down
2 changes: 2 additions & 0 deletions v20.2/install-cockroachdb-windows.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<p>See <a href="../releases/{{page.release_info.version}}.html" class="mac-releasenotes-download" id="mac-releasenotes-download-{{page.version.version}}" data-eventcategory="mac-releasenotes-download">Release Notes</a> for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see <a href="upgrade-cockroach-version.html">Cluster Upgrade</a>.</p>

{% include cockroachcloud/use-cockroachcloud-instead.md %}

<div id="download-the-binary-windows" class="install-option">
<h2>Download the executable</h2>

Expand Down
7 changes: 3 additions & 4 deletions v20.2/secure-a-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@ asciicast: true
---

<div class="filters filters-big clearfix">
<a href="start-a-local-cluster.html"><button class="filter-button">Insecure</button></a>
<a href="secure-a-cluster.html"><button class="filter-button current"><strong>Secure</strong></button></a>
<a href="start-a-local-cluster.html"><button class="filter-button">Insecure</button></a>
</div>

Once you've [installed CockroachDB](install-cockroachdb.html), it's simple to run a secure multi-node cluster locally, using [TLS certificates](cockroach-cert.html) to encrypt network communication.

{{site.data.alerts.callout_info}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed CockroachDB](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down
11 changes: 5 additions & 6 deletions v20.2/start-a-local-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,19 @@ asciicast: true
---

<div class="filters filters-big clearfix">
<a href="start-a-local-cluster.html"><button class="filter-button current"><strong>Insecure</strong></button></a>
<a href="secure-a-cluster.html"><button class="filter-button">Secure</button></a>
<a href="start-a-local-cluster.html"><button class="filter-button current"><strong>Insecure</strong></button></a>
</div>

Once you've [installed CockroachDB](install-cockroachdb.html), it's simple to run an insecure multi-node cluster locally.

{{site.data.alerts.callout_info}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed CockroachDB](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html), and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: Update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down Expand Up @@ -68,8 +67,8 @@ Also, feel free to watch this process in action before going through the steps y
- The `--insecure` flag makes communication unencrypted.
- Since this is a purely local cluster, `--listen-addr=localhost:26257` and `--http-addr=localhost:8080` tell the node to listen only on `localhost`, with port `26257` used for internal and client traffic and port `8080` used for HTTP requests from the Admin UI.
- The `--store` flag indicates the location where the node's data and logs are stored.
- The `--join` flag specifies the addresses and ports of the nodes that will initially comprise your cluster. You'll use this exact `--join` flag when starting other nodes as well.
- The `--join` flag specifies the addresses and ports of the nodes that will initially comprise your cluster. You'll use this exact `--join` flag when starting other nodes as well.
{% include {{ page.version.version }}/prod-deployment/join-flag-single-region.md %}
- The `--background` flag starts the `cockroach` process in the background so you can continue using the same terminal for other operations.
Expand Down

0 comments on commit 7bc729d

Please sign in to comment.