Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Refresh tutorial screenshots for new branding and consistency #72

Merged
merged 1 commit into from
Mar 25, 2022
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
Binary file modified docs/_assets/img/cloud-create-org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/img/cloud-edge-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/cloud-regions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_assets/img/cloud-sign-in-azure.png
Binary file not shown.
Binary file modified docs/_assets/img/cloud-signup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/free-trial-organization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/free-trial-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/stripe-adminui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/stripe-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/img/stripe-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 18 additions & 18 deletions docs/edge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ directly to the cluster configuration. You can configure your desired hardware
values for CPU, RAM, and storage per node manually in the panel provided, as
well as the number of nodes you want in your cluster.

.. image:: _assets/img/edge-config.png
.. image:: _assets/img/cloud-edge-config.png
:alt: Cluster configuration panels for CrateDB Edge

On the right the cluster scale overview shows the total hardware values for the
Expand All @@ -245,7 +245,7 @@ here. However, you can now define a project that the cluster can be deployed
in, as well as the cluster name. You also determine the database username and
password that you can use to access the cluster `Admin UI`_ later on.

.. image:: _assets/img/stripe-settings.png
.. image:: _assets/img/cloud-edge-settings.png
:alt: Account settings menu

Note that the cluster name has certain validation requirements: it may contain
Expand Down Expand Up @@ -684,21 +684,21 @@ With this, you should be ready to use CrateDB Edge via K3S.
Custom TLS certificates
=======================

By default, CrateDB Edge will issue self-signed certificates for CrateDB
instances running in your Edge region. It is also possible to use "proper" TLS
certificates if required. In the examples below, we will configure
By default, CrateDB Edge will issue self-signed certificates for CrateDB
instances running in your Edge region. It is also possible to use "proper" TLS
certificates if required. In the examples below, we will configure
`letsencrypt`_ to issue certificates and use them with CrateDB Edge clusters.


Create a ``ClusterIssuer``
--------------------------

CrateDB Edge uses an industry standard app called `cert-manager`_ for managing
TLS certificates. To issue valid certificates, you would need to follow the
cert-manager `tutorial for letsencrypt via the DNS solver`_. CrateDB clusters
are provisioned behind a Load Balancer, and as such the only way to solve
CrateDB Edge uses an industry standard app called `cert-manager`_ for managing
TLS certificates. To issue valid certificates, you would need to follow the
cert-manager `tutorial for letsencrypt via the DNS solver`_. CrateDB clusters
are provisioned behind a Load Balancer, and as such the only way to solve
letsencrypt challenges is via DNS. Your configuration will vary, but if you use
``Route53`` as your DNS provider, you will end up with a configuration similar
``Route53`` as your DNS provider, you will end up with a configuration similar
to this:

.. code-block:: yaml
Expand Down Expand Up @@ -726,7 +726,7 @@ to this:
Ask for a new certificate
-------------------------

To ask `letsencrypt`_ for a new certificate, create a ``Certificate``
To ask `letsencrypt`_ for a new certificate, create a ``Certificate``
Kubernetes resource:

.. code-block:: yaml
Expand Down Expand Up @@ -757,7 +757,7 @@ Kubernetes resource:

.. NOTE::

Note that you must do this inside of a namespace where your CrateDB will be
Note that you must do this inside of a namespace where your CrateDB will be
running.

The secret called ``keystore-passwords`` will be created automatically when you
Expand All @@ -767,15 +767,15 @@ create the CrateDB Cloud Project in this region.
Replace the existing certificate used by your cluster
-----------------------------------------------------

As your CrateDB Edge cluster comes with a self-signed certificate, you will
need to replace it. Fortunately, this is fairly straightforward, and only
As your CrateDB Edge cluster comes with a self-signed certificate, you will
need to replace it. Fortunately, this is fairly straightforward, and only
requires a quick edit to the CrateDB Cluster's ``StatefulSet``, i.e.:

.. code-block:: console

$ kubectl -n $YOUR_NAMESPACE edit sts crate-data-hot-$CLUSTER_ID

Then find the following section and replace the secret name with the
Then find the following section and replace the secret name with the
``secretName`` specified when creating the ``Certificate`` entity above, i.e.:

.. code-block:: yaml
Expand All @@ -788,15 +788,15 @@ Then find the following section and replace the secret name with the
path: keystore.jks
secretName: my-target-secret-for-this-certificate

Once this is done, you will have to bounce each of the CrateDB pods for the
change to be picked up. Once the pods are back up, they will present the
Once this is done, you will have to bounce each of the CrateDB pods for the
change to be picked up. Once the pods are back up, they will present the
configured certificate on both the HTTP and PGSQL ports.

.. NOTE::

Note that you need to access CrateDB via a valid DNS name for this to work,
so make sure that ``my-cluster-1.my.fully.qualified.domain.example.com``
correctly points to your CrateDB instance (i.e. via an external network
correctly points to your CrateDB instance (i.e. via an external network
load balancer).


Expand Down
2 changes: 1 addition & 1 deletion docs/sign-up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Sign up via Azure AD
Visit the `CrateDB Cloud Console`_. You should be presented with a Microsoft
Azure *Active Directory* (AD) sign in option:

.. image:: _assets/img/cloud-sign-in-azure.png
.. image:: _assets/img/cloud-signup.png
:alt: Azure sign-in screen

You must have an Azure account to proceed.
Expand Down