{"id":13472439,"url":"https://github.com/vmware-labs/node-replicated-kernel","last_synced_at":"2025-03-26T15:32:19.875Z","repository":{"id":37076405,"uuid":"363727578","full_name":"vmware-labs/node-replicated-kernel","owner":"vmware-labs","description":"Experimental kernel with built-in replication.","archived":false,"fork":false,"pushed_at":"2024-03-12T17:36:38.000Z","size":9206,"stargazers_count":153,"open_issues_count":24,"forks_count":17,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-30T04:14:17.233Z","etag":null,"topics":["amd64","kernel","operating-systems","os","rust","x86-64"],"latest_commit_sha":null,"homepage":"https://nrkernel.systems","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vmware-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-02T18:57:24.000Z","updated_at":"2024-10-14T15:55:24.000Z","dependencies_parsed_at":"2024-03-02T04:21:57.668Z","dependency_job_id":"0b30d7a7-bd4d-4a33-a2a3-c66d26eb6874","html_url":"https://github.com/vmware-labs/node-replicated-kernel","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-labs%2Fnode-replicated-kernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-labs%2Fnode-replicated-kernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-labs%2Fnode-replicated-kernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-labs%2Fnode-replicated-kernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vmware-labs","download_url":"https://codeload.github.com/vmware-labs/node-replicated-kernel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245681468,"owners_count":20655202,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amd64","kernel","operating-systems","os","rust","x86-64"],"created_at":"2024-07-31T16:00:54.632Z","updated_at":"2025-03-26T15:32:18.331Z","avatar_url":"https://github.com/vmware-labs.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Node Replicated Kernel\n\nThe Node Replicated Kernel is an (experimental) research OS kernel for x86-64\n(amd64) machines written in rust. You can read more about it\n[here](https://nrkernel.systems/book/).\n\n## Installation\n\n### Check-out the source tree\n\n1. `git clone \u003crepo-url\u003e nrk`\n1. `cd nrk`\n1. Note: In case you don't have the SSH key of your machine registered with a github account,\nyou need to convert the submodule URLs to the https protocol, to do so run:\n`sed -i'' -e 's/git@github.com:/https:\\/\\/github.com\\//' .gitmodules`\n1. `git submodule update --init`\n\n### Install dependencies\n\nRun `bash setup.sh`, this will install required dependencies on Linux to build and run nrk.\n\n### Build and run\n\n1. `cd kernel`\n1. `python3 ./run.py`\n\nIf you just want to compile the code you can also execute `run.py` with the\n`--norun` flag.\n\n## Development\n\n### Testing\n\nTo run the unit tests of the kernel:\n\n1. `cd kernel`\n1. `RUST_BACKTRACE=1 RUST_TEST_THREADS=1 cargo test --bin nrk`\n\nTo run the integration tests of the kernel:\n\n1. `cd kernel`\n1. `RUST_TEST_THREADS=1 cargo test --features smoke --test integration-test`\n\nIf you would like to run a specific integration test you can pass it with `--`:\n\n1. `RUST_TEST_THREADS=1 cargo test --test integration-test -- --nocapture userspace_smoke`\n\n\u003e Note: Parallel testing is not possible at the moment due to reliance on build flags for testing.\n\n### Submitting a change\n\nUpdate latest master:\n\n1. `git checkout master`\n1. `git pull`\n1. `git submodule update --init`\n\nCreate a new feature branch:\n\n1. `git checkout -b \u003cBRANCH-NAME\u003e`\n1. Make changes in code.\n\nMake sure that the code compiles without warnings, is properly formatted and passes tests:\n\n1. `cd kernel`\n1. `bash commitable.sh`\n\nCommit changes and push\n\n1. `git add \u003cCHANGED-FILES\u003e`\n1. `git commit`\n1. `git push -u origin \u003cBRANCH-NAME\u003e`\n1. Create a Pull Request on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-labs%2Fnode-replicated-kernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvmware-labs%2Fnode-replicated-kernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-labs%2Fnode-replicated-kernel/lists"}