Skip to content

Commit

Permalink
chore: rewrite everything in go (#1)
Browse files Browse the repository at this point in the history 
* chore: setup cmdlines for k3s

* fix: boot script

* chore: make host and new_host configurable by env vars

* feat: change hostname

* feat: start script migration to go

* chore: set up cmd commands

* feat: create deployer group

* chore: follow go best practices

* chore: add debug flag

* feat: add deployer user

* feat: detect already set up sudoer

* feat: create deployer user

* feat: set up ssh keys from aws lambda

* feat: setup sshd config

* feat: disable login user

* chore: modify test_deploy to use go temporarily

* chore: split layer1 code into files

* chore: rename go module

* chore: move uploadsshKeys to ssh file

* fix: ensure .ssh folder exists before uploading ssh keys

* chore: improve boot command

* feat: add authorized-keys command

* fix: do not update ssh keys if not modified

* chore: rename cli

* chore: mark flags as required

* feat: set deployer password

* feat: set root password

* feat: add network command

* feat: add --static-ip flag in layer1

* refactor: remove useless checks

* feat: join aws flags

* feat: add chpasswd to path in dockerfile

* style: run gofmt

* fix: append sudoer instead of rewriting file

* chore: remove useless expandPath in authorizedKeys

* feat: set hostname in layer1

* feat: improve info in network command

* chore: change module name according to gh

* chore: change again go.mod

* docs: start redacting readme

* refactor: change checks in layer1

* refactor: change arg checks in authorized-keys

* refactor: change arg checks in ntework

* refactor: remove arg checks in boot command

* feat: enable multiple executions of network command

* feat: start development of layer2 command

* fix: new layer 2 command

* chore: add usermod to docker image

* fix: run usermod as root

* chore: improve layer2 command

* chore: start refactoring ssh.go

* chore: refactor ssh code

* chore: allow public keys input from file instead of s3

* chore: improve info messages

* chore: improve error messages

* chore: improve error messages

* chore: remove layer3 command

* chore: add country flag to boot command

* docs: update readme

* docs: add networking section

* chore: remove old python files

* chore: move test files into test dir
  • Loading branch information
@sralloza
sralloza committed Nov 5, 2021
1 parent a84777e commit 183ce32
Show file tree
Hide file tree
Showing 22 changed files with 2,519 additions and 561 deletions.
202 changes: 202 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http:https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http:https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
168 changes: 168 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Rpi-provision

_Have your raspberry pi ready to go using a couple commands._

When your Raspberry Pi with all your projects dies it's a real pain to set it up again. Install your favourite shell, update all packagaes, set up the ssh connection, the static ip address...

That's why this repo was created. The first version was created in Python, but the sudo password detection was really buggy, so now it's rewritten in go.

## Problems & Solutions

### Initial setup

What happens if you don't have an spare screen and keyboard? Don't worry, this script has your back. After flashing your raspbian image into your ssh card, execute the `boot` command. It will setup the ssh server and optionally a wifi connection to work the first time you turn your raspberry on. By default it will also add some lines to `cmdline.txt` to enable some features needed to run a k3s cluster. If you want to disable it, pass `--cmdline=""` to the `boot` command.

Note: you must pass the path of your sd card (the `BOOT_PATH` argument). In windows it will likely be `E:/`, `F:/` or something similar.

### SSH Keys management

I have some PCs with ssh keys, so naturally I would want to be able to ssh into the Raspberry from any of my PCs.

But, what happens if I change one key? Do I have to manually add the key to each Raspberry I have?

With this script, no. You just have to change your public ssh in the file. You just need to write your public ssh keys into a json file and upload it to an s3 bucket.

Note: if you don't want to use AWS S3 to store your keys file, use the `--keys-path` command to specify the path to the file where you store your public keys.

Example:

```json
{
"key-id-1": "public-ssh-key-1",
"key-id-1": "public-ssh-key-1"
}
```

Then you set your AWS env vars (`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`). If you don't have them, a simple google search will tell you how to generate them. You will need to tell the script where your file containing the public ssh keys is in AWS. You do it with the `--s3-path` flag: `--s3-path=<REGION>/<BUCKET_NAME>/<FILE_NAME>`. If you don't use this convention the script will complain and raise an error.

We have covered how to store your public ssh keys. How can you update the ssh keys in your raspberry's authorized_keys? Simple, just use the [authorized-keys](#authorized-keys) command (or the [layer1](#layer1) command if you set up the raspberry for the first time).

### Networking

You will probably ssh often into your rapsberry pi, you chances are you want to setup a static IP address. It's really simple to do it, just use the [network](#network) command.

## Commands

### boot

```shell
$ rpi-provisioner boot --help
Enable ssh, modify cmdline.txt and setup wifi connection

Usage:
rpi-provision boot [BOOT_PATH] [flags]

Flags:
--cmdline stringArray Extra args to append to cmdline.txt (default [cgroup_enable=cpuset,cgroup_enable=memory,cgroup_memory=1])
--country string Country code (2 digits) (default "ES")
-h, --help help for boot
--wifi-pass string WiFi password
--wifi-ssid string WiFi SSID

Global Flags:
--debug Enable debug 21:33:29
```

### authorized-keys

```shell
$ rpi-provisioner authorized-keys --help
Download keys from the S3 bucket and update them.

Usage:
rpi-provision authorized-keys [flags]

Flags:
-h, --help help for authorized-keys
--host string Server host
--keys-path string Local keys file path. You can select the public key file or a file containing multiple public keys.
--password string Login password
--port int Server SSH port (default 22)
--s3-path string Amazon S3 path. Must match the pattern region/bucket/file
--ssh-key Use ssh key
--user string Login user

Global Flags:
--debug Enable debug
```
As said before, it will download the public ssh keys from AWS and update them. You can use ssh with an already valid ssh-key or the user's password. If you want to use your ssh key use the flag `--ssh-key`. It will get your private ssh key located at `~/.ssh/id_rsa` by default. Right now the private key path is not configurable. If you want to use the password to log in, use the `--password` flag.
### network
```shell
$ rpi-provisioner network --help
Set up static ip for eth0 and wlan0.
Usage:
rpi-provision network [flags]
Flags:
-h, --help help for network
--host string Server host
--ip ip New IP
--password string Login password
--port int Server SSH port (default 22)
--ssh-key Use ssh key
--user string Login user
Global Flags:
--debug Enable debug
```
This commands just edits the dhcpd config to set an static IP Address for both eth0 and wlan0. It provisions the same IP Adress for both interfaces, but it gives priority to eth0.
### layer1
```shell
$ rpi-provisioner layer1 --help
Layer 1 uses the default user and bash shell. It will perform the following tasks:
- Create deployer user
- Set hostname
- Setup ssh config and keys
- Disable pi login
- [optional] static ip configuration
Usage:
rpi-provision layer1 [flags]
Flags:
--deployer-password string Deployer password
--deployer-user string Deployer user
-h, --help help for layer1
--host string Server host
--hostname string Server hostname
--keys-path string Local keys file path. You can select the public key file or a file containing multiple public keys.
--login-password string Login password
--login-user string Login user
--port int Server SSH port (default 22)
--root-password string Root password
--s3-path string Amazon S3 path. Must match the pattern region/bucket/file
--static-ip ip Set up the static ip for eth0 and wlan0
Global Flags:
--debug Enable debug
```
### layer2
```shell
$ rpi-provisioner layer2 --help
Layer 2 uses the deployer user and bash. It will perform the following tasks:
- Update and upgrade packages
- Install libraries: build-essential, cmake, cron, curl, git, libffi-dev, nano, python3-pip, python3, wget
- Install fish
- Install docker
Usage:
rpi-provision layer2 [flags]
Flags:
-h, --help help for layer2
--host string Server host
--port int Server SSH port (default 22)
--user string Login user
Global Flags:
--debug Enable debug
```
Loading

0 comments on commit 183ce32

Please sign in to comment.