Update Redis app directory #20

razvand · 2023-09-09T18:04:14Z

Rework the contents of the Redis app directory to make it more suitable for users (prime tool is KraftKit) and for developers (prime tools are Make, Kconfig, QEMU / Firecracker).

Move and output files in dedicated directories to keep the root directory clean: kraft.yaml, README.md, Makefile, Makefile.uk are the only files in the dedicated directories.

Update README.md according to the new structure.

Improve support for KraftKit: documentation, run scriipts, testing.

StefanJum

Looks good, just a few comments.

Do we only provide basic config files? (i.e. not the pie-paging etc. ones)
Would it make sense to keep the config naming convention kraft uses (config.appname-arch...)?

StefanJum · 2023-09-10T13:53:30Z

README.md

+Note that, if you want to build for a different architecture then the previous build, currently you are required to remove the generated files.
+For that, run the command:
+
+```console
+rm -fr .config* .unikraft/
+```


Is that required when using kraft?

Yes, I get errors if I don't do that.

README.md

razvand · 2023-09-10T22:45:44Z

Do we only provide basic config files? (i.e. not the pie-paging etc. ones)

I will add all of them from the maintainer-tools repository.

Would it make sense to keep the config naming convention kraft uses (config.appname-arch...)?

My thought was to simplify the names as much as possible. But if more people think we should use config.appname-..., then I will update accordingly. Cc: @skuenzer , @nderjung , @andreittr

StefanJum

I will add all of them from the maintainer-tools repository.

Perfect

My thought was to simplify the names as much as possible. But if more people think we should use config.appname-..., then I will update accordingly.

Makes sense, I don't have a strong opinion here, just if maybe the configs can be used by kraft somehow, but that should not be the case since kraft should only care about the kraft.yaml file.

It looks all good on my side besides the one small comment.

README.md

`.unikraft/` was previously used as the directory to clone library repositories (including the `unikraft` core repository). Being a hidden, it is not immediately available to the developer. Use `workdir/` instead. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

For consistency on placing external and generated files, place the build directory in `workdir/build/` instead of `build/`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

The build system may bump into issues when using `make` right out the configuration. Use `make prepare` before `make` for a "safe" build. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Move configuration files to `defconfigs/` directory to have them all in one place. Simplify their names and remove the preceding dot, to make them visible to the developer / user. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Move run scripts to `run/` directory. This cleans up the application root directory. Remove the `run-` prefix from their name; this combines nicely with the `run/` directory that will prefix the run comman Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Remove instructions to create and enter directories. `git clone` commands create the necessary parent directories. This simplifies the instructions in `README.md`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

`fs1` is used by KraftKit as the root device. Update `kraft.yaml` accordingly, to use `fs1` instead of `fs0`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Update `redis.conf` configuration file to bind the Redis server to all addresses (`0.0.0.0`), instead of just `172.44.0.2`. This is useful when using networking setups where the address is not beforehand and cannot be filled in the configuration file. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Add scripts in the `run/` directory that use `kraft run` to start Unikraft Redis instances. Add scripts for targets in `kraft.yaml`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

`fs0` is a leftover term. Use `rootfs` as the name of the directory storing the root filesystem. It corresponds better to its purpose. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Use `fs1` instead of `fs0` for basic builds for consistency with KraftKit, that defaults to `fs1` as the first mount tag. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Update all configurations in `kraft.yaml` to feature proper configuration options. Use `arm64` instead of `aarch64` in target names. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Reduce default configuration files (in the `deconfigs/` directory) to their minimal configurations. Also add default configuration file for Firecracker on AArch64. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Add `scripts/` directory that provides support for generating build and run scripts. Generator script is stored externally, in the `app-testing` repository. The `run.yaml` file defines the possible running configurations. This deprecates the `run/` directory, so remove it. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Update `.gitignore` to ignore generated `rootfs.cpio` file. Previously, the `fs0.cpio` file was generated. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Update instructions for building. Add instruction on using build and run scripts. Add detailed commands on building and running. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

StefanJum

Either add the setup.sh script (and mention it in the TLDR section) or add the cloning steps back into the TLDR section.

Introduce `scripts/setup.sh` script to clone repositories in the `workdir/` directory. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

StefanJum

All good.
Reviewed-by: Stefan Jumarea stefanjumarea02@gmail.com
Approved-by: Stefan Jumarea stefanjumarea02@gmail.com

`.unikraft/` was previously used as the directory to clone library repositories (including the `unikraft` core repository). Being a hidden, it is not immediately available to the developer. Use `workdir/` instead. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

For consistency on placing external and generated files, place the build directory in `workdir/build/` instead of `build/`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

The build system may bump into issues when using `make` right out the configuration. Use `make prepare` before `make` for a "safe" build. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Move configuration files to `defconfigs/` directory to have them all in one place. Simplify their names and remove the preceding dot, to make them visible to the developer / user. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Move run scripts to `run/` directory. This cleans up the application root directory. Remove the `run-` prefix from their name; this combines nicely with the `run/` directory that will prefix the run comman Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> eviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Remove instructions to create and enter directories. `git clone` commands create the necessary parent directories. This simplifies the instructions in `README.md`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

`fs1` is used by KraftKit as the root device. Update `kraft.yaml` accordingly, to use `fs1` instead of `fs0`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Update `redis.conf` configuration file to bind the Redis server to all addresses (`0.0.0.0`), instead of just `172.44.0.2`. This is useful when using networking setups where the address is not beforehand and cannot be filled in the configuration file. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Add scripts in the `run/` directory that use `kraft run` to start Unikraft Redis instances. Add scripts for targets in `kraft.yaml`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

`fs0` is a leftover term. Use `rootfs` as the name of the directory storing the root filesystem. It corresponds better to its purpose. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Use `fs1` instead of `fs0` for basic builds for consistency with KraftKit, that defaults to `fs1` as the first mount tag. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Update all configurations in `kraft.yaml` to feature proper configuration options. Use `arm64` instead of `aarch64` in target names. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Reduce default configuration files (in the `deconfigs/` directory) to their minimal configurations. Also add default configuration file for Firecracker on AArch64. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Add `scripts/` directory that provides support for generating build and run scripts. Generator script is stored externally, in the `app-testing` repository. The `run.yaml` file defines the possible running configurations. This deprecates the `run/` directory, so remove it. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Update `.gitignore` to ignore generated `rootfs.cpio` file. Previously, the `fs0.cpio` file was generated. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Update instructions for building. Add instruction on using build and run scripts. Add detailed commands on building and running. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

Introduce `scripts/setup.sh` script to clone repositories in the `workdir/` directory. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Stefan Jumarea <stefanjumarea02@gmail.com> GitHub-Closes: #20

razvand added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 9, 2023

razvand requested a review from StefanJum September 9, 2023 18:04

razvand assigned skuenzer Sep 9, 2023

razvand changed the base branch from stable to staging September 9, 2023 18:04

StefanJum suggested changes Sep 10, 2023

View reviewed changes

razvand force-pushed the razvand/update-app-directory branch from 80de1dc to 8a03a45 Compare September 10, 2023 22:53

razvand requested a review from StefanJum September 10, 2023 22:53

StefanJum reviewed Sep 11, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

razvand added 11 commits September 15, 2023 09:35

Use workdir/build/ as output directory

4a3fe83

For consistency on placing external and generated files, place the build directory in `workdir/build/` instead of `build/`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

README: Use make prepare before build command

911907d

The build system may bump into issues when using `make` right out the configuration. Use `make prepare` before `make` for a "safe" build. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Move config files to defconfigs/

277fd4c

Move configuration files to `defconfigs/` directory to have them all in one place. Simplify their names and remove the preceding dot, to make them visible to the developer / user. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

README: Simplify clone instructions

099b3c6

Remove instructions to create and enter directories. `git clone` commands create the necessary parent directories. This simplifies the instructions in `README.md`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

kraft.yaml: Use fs1 as root device

22a7c8b

`fs1` is used by KraftKit as the root device. Update `kraft.yaml` accordingly, to use `fs1` instead of `fs0`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Add wrapper scripts to run KraftKit

4e221d4

Add scripts in the `run/` directory that use `kraft run` to start Unikraft Redis instances. Add scripts for targets in `kraft.yaml`. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Rename fs0/ to rootfs/

15aeb6d

`fs0` is a leftover term. Use `rootfs` as the name of the directory storing the root filesystem. It corresponds better to its purpose. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

Use mount tag fs1 for basic builds

733989d

Use `fs1` instead of `fs0` for basic builds for consistency with KraftKit, that defaults to `fs1` as the first mount tag. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

razvand assigned StefanJum and unassigned skuenzer Oct 1, 2023

razvand added 5 commits October 1, 2023 06:39

kraft.yaml: Update all configurations

4faa265

Update all configurations in `kraft.yaml` to feature proper configuration options. Use `arm64` instead of `aarch64` in target names. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

defconfigs: Reduce configuration files

665c536

Reduce default configuration files (in the `deconfigs/` directory) to their minimal configurations. Also add default configuration file for Firecracker on AArch64. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

.gitignore: Ignore generated rootfs.cpio

b101923

Update `.gitignore` to ignore generated `rootfs.cpio` file. Previously, the `fs0.cpio` file was generated. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

README.md: Update instructions

d748d7d

Update instructions for building. Add instruction on using build and run scripts. Add detailed commands on building and running. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

razvand force-pushed the razvand/update-app-directory branch from 8a03a45 to d748d7d Compare October 1, 2023 04:10

razvand requested a review from StefanJum October 1, 2023 04:11

StefanJum suggested changes Oct 1, 2023

View reviewed changes

razvand requested a review from StefanJum October 2, 2023 03:29

Introduce setup script to clone repositories

99da53c

Introduce `scripts/setup.sh` script to clone repositories in the `workdir/` directory. Signed-off-by: Razvan Deaconescu <razvand@unikraft.io>

razvand force-pushed the razvand/update-app-directory branch from ca20c73 to 99da53c Compare October 2, 2023 04:00

StefanJum approved these changes Oct 2, 2023

View reviewed changes

razvand merged commit 67ec01f into unikraft:staging Oct 3, 2023

razvand deleted the razvand/update-app-directory branch October 3, 2023 15:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Redis app directory #20

Update Redis app directory #20

razvand commented Sep 9, 2023

StefanJum left a comment

StefanJum Sep 10, 2023

razvand Sep 10, 2023

razvand commented Sep 10, 2023 •

edited

Loading

StefanJum left a comment

StefanJum left a comment

StefanJum left a comment

Update Redis app directory #20

Update Redis app directory #20

Conversation

razvand commented Sep 9, 2023

StefanJum left a comment

Choose a reason for hiding this comment

StefanJum Sep 10, 2023

Choose a reason for hiding this comment

razvand Sep 10, 2023

Choose a reason for hiding this comment

razvand commented Sep 10, 2023 • edited Loading

StefanJum left a comment

Choose a reason for hiding this comment

StefanJum left a comment

Choose a reason for hiding this comment

StefanJum left a comment

Choose a reason for hiding this comment

razvand commented Sep 10, 2023 •

edited

Loading