{"id":18673011,"url":"https://github.com/projectsyn/commodore-component-tutorial","last_synced_at":"2025-11-06T23:30:23.430Z","repository":{"id":52375882,"uuid":"290452506","full_name":"projectsyn/commodore-component-tutorial","owner":"projectsyn","description":"Step-by-step guide to create a small Commodore component","archived":false,"fork":false,"pushed_at":"2023-12-15T05:42:16.000Z","size":1008,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-12-27T19:44:14.906Z","etag":null,"topics":["commodore","projectsyn","syn","tutorial"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/projectsyn.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-08-26T09:23:47.000Z","updated_at":"2021-11-09T07:58:20.000Z","dependencies_parsed_at":"2023-12-15T06:49:41.050Z","dependency_job_id":null,"html_url":"https://github.com/projectsyn/commodore-component-tutorial","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/projectsyn%2Fcommodore-component-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcommodore-component-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcommodore-component-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcommodore-component-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectsyn","download_url":"https://codeload.github.com/projectsyn/commodore-component-tutorial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239513379,"owners_count":19651322,"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":["commodore","projectsyn","syn","tutorial"],"created_at":"2024-11-07T09:13:40.385Z","updated_at":"2025-11-06T23:30:23.363Z","avatar_url":"https://github.com/projectsyn.png","language":"Shell","readme":"= Getting Started with Commodore Components\n\nThis tutorial provides all the information required to create your first Commodore component. https://syn.tools/tuto/index.html[This tutorial can be found] in the official Project Syn documentation.\n\n== Contents\n\nThe contents of the tutorial are in the `docs/modules/ROOT/pages/index.adoc` file. The scripts help encapsulate the knowledge required to spin up a Project Syn installation with at least 2 clusters.\n\nThe instructions of the tutorial guide the user to the creation and deployment of a simple component.\n\n== Requirements\n\nThe `0_requirements.sh` script shows the current versions of all required software.\n\n=== Podman instead of Docker\n\nIf you do not have Docker installed or would prefer to use https://podman.io/[Podman], https://kind.sigs.k8s.io/[kind] is 100% compatible with Podman and has been successfully tested with this tutorial.\n\nAt the time of the last update of this document, k3d 5.5 is not compatible with Podman, https://k3d.io/v5.5.1/usage/advanced/podman/[despite what the documentation says].\n\n== Build PDF\n\nUse the `make pdf` command to create a PDF file out of the source Asciidoc file in the `build` folder. This operation requires Docker.\n\n== Troubleshooting\n\nSome users of Btrfs-on-LUKS have experimented issues with the tutorial. You might want to perform the following changes in that case.\n\n. In `1_lieutenant_on_minikube.sh`, line 12, use the following command to start Minikube: `minikube start --disk-size 60g --cpus 4 --feature-gates=\"LocalStorageCapacityIsolation=false\"`\n. In `4_synthesize_on_k3s.sh`, replace line 22 `k3d cluster create projectsyn` with the following:\n\n[source,bash]\n--\nif [ -d /dev/mapper ]; then\nk3d_extra_args=\"-v /dev/mapper:/dev/mapper\"\nelse\nk3d_extra_args=\"\"\nfi\nk3d cluster create projectsyn ${k3d_extra_args}\n--\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectsyn%2Fcommodore-component-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectsyn%2Fcommodore-component-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectsyn%2Fcommodore-component-tutorial/lists"}