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.

Sign up for GitHub

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

Updates to quickstart #2

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Updates to quickstart #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b43c5fc
Updates to `quickstart`
gab-arrobo Apr 10, 2024
fe44925
Some additional simplifications to the documentation
gab-arrobo Apr 10, 2024
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
69 changes: 34 additions & 35 deletions onramp/start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,14 @@ follows:

.. code-block::

$ sudo apt install sshpass python3-venv pipx
$ sudo apt install sshpass python3-venv pipx make git
$ pipx install --include-deps ansible
$ pipx ensurepath
$ source ~/.bashrc

Once installed, displaying the Ansible version number should result in
output similar to the following on Ubuntu 20.04. (Ubuntu 22.04 will
show ``ansible [core 2.16.2]``.)
show ``ansible [core 2.16.4]``.)

.. code-block::

Expand All @@ -82,10 +83,6 @@ show ``ansible [core 2.16.2]``.)
libyaml = True


Note that a fresh install of Ubuntu may be missing other packages that
you need (e.g., ``git``, ``curl``, ``make``), but you will be prompted
to install them as you step through the Quick Start sequence.

Download Aether OnRamp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -154,10 +151,16 @@ same server you will be installing Aether on.

In this example, address ``10.76.28.113`` and the three occurrences
of the string ``aether`` need to be replaced with the appropriate
values. Note that if you set up your server to use SSH keys instead
of passwords, then ``ansible_password=aether`` needs to be replaced
with ``ansible_ssh_private_key_file=~/.ssh/id_rsa`` (or wherever
your private key can be found).
values.

Note that if you set up your server to use SSH keys instead
of passwords, update the ``hosts.ini`` with your private key (accordingly
adjust the location and filename of your private key)

.. code-block::

node1 ansible_host=10.76.28.113 ansible_user=aether ansible_ssh_private_key_file=~/.ssh/id_rsa


The second set of parameters is in ``vars/main.yml``, where the **two** lines
currently reading
Expand Down Expand Up @@ -213,31 +216,7 @@ you may want to modify as we move beyond the Quick Start deployment.
We'll identify those files throughout this section, for informational
purposes, and revisit them in later sections.

Many of the tasks specified in the various Ansible playbooks result in
calls to Kubernetes, either directly via ``kubectl``, or indirectly
via ``helm``. This means that after executing the sequence of
Makefile targets described in the rest of this guide, you'll want to
run some combination of the following commands to verify that the
right things happened:

.. code-block::

$ kubectl get pods --all-namespaces
$ helm repo list
$ helm list --namespace kube-system

The first reports the set of Kubernetes namespaces currently running;
the second shows the known set of repos you are pulling charts from;
and the third shows the version numbers of the charts currently
deployed in the ``kube-system`` namespace.

If you are not familiar with ``kubectl`` (the CLI for Kubernetes), we
recommend that you start with `Kubernetes Tutorial
<https://kubernetes.io/docs/tutorials/kubernetes-basics/>`__.

Note that we have not yet installed Kubernetes or Helm, so these
commands are not yet available. At this point, the only verification
step you can take is to type the following:
At this point, the only verification step you can take is to type the following:

.. code-block::

Expand All @@ -262,6 +241,26 @@ targets will output red results from time-to-time (indicating an
exception or failure), but as long as Ansible keeps progressing
through the playbook, such output can be safely ignored.

Many of the tasks specified in the various Ansible playbooks result in
calls to Kubernetes, either directly via ``kubectl``, or indirectly
via ``helm``. This means that you may want to run some combination of the
following commands to verify that the right things happened:

.. code-block::

$ kubectl get pods --all-namespaces
$ helm repo list
$ helm list --namespace kube-system

The first reports the set of Kubernetes namespaces currently running;
the second shows the known set of repos you are pulling charts from;
and the third shows the version numbers of the charts currently
deployed in the ``kube-system`` namespace.

If you are not familiar with ``kubectl`` (the CLI for Kubernetes), we
recommend that you start with `Kubernetes Tutorial
<https://kubernetes.io/docs/tutorials/kubernetes-basics/>`__.

Once the playbook completes, executing ``kubectl`` will show the
``kube-system`` namespace running, with output looking something like
the following:
Expand Down