{"id":13993426,"url":"https://github.com/coreos/coreos-vagrant","last_synced_at":"2025-09-27T10:31:48.288Z","repository":{"id":9852181,"uuid":"11846692","full_name":"coreos/coreos-vagrant","owner":"coreos","description":"Minimal Vagrantfile for Container Linux","archived":true,"fork":false,"pushed_at":"2018-07-26T12:50:40.000Z","size":129,"stargazers_count":1649,"open_issues_count":10,"forks_count":646,"subscribers_count":98,"default_branch":"master","last_synced_at":"2025-01-17T20:38:11.456Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coreos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-02T15:41:22.000Z","updated_at":"2024-11-30T06:51:31.000Z","dependencies_parsed_at":"2022-09-09T23:02:34.405Z","dependency_job_id":null,"html_url":"https://github.com/coreos/coreos-vagrant","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/coreos/coreos-vagrant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fcoreos-vagrant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fcoreos-vagrant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fcoreos-vagrant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fcoreos-vagrant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coreos","download_url":"https://codeload.github.com/coreos/coreos-vagrant/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fcoreos-vagrant/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277218955,"owners_count":25781447,"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","status":"online","status_checked_at":"2025-09-27T02:00:08.978Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-08-09T14:02:22.528Z","updated_at":"2025-09-27T10:31:48.066Z","avatar_url":"https://github.com/coreos.png","language":null,"readme":"# CoreOS Vagrant\n\nThis repo provides a template Vagrantfile to create a CoreOS virtual machine using the VirtualBox software hypervisor.\nAfter setup is complete you will have a single CoreOS virtual machine running on your local machine.\n\n## Contact\nIRC: #coreos on freenode.org\n\nMailing list: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)\n\n## Streamlined setup\n\n1) Install dependencies\n\n* [VirtualBox][virtualbox] 4.3.10 or greater.\n* [Vagrant][vagrant] 1.6.3 or greater.\n\n2) Clone this project and get it running!\n\n```\ngit clone https://github.com/coreos/coreos-vagrant/\ncd coreos-vagrant\n```\n\n3) Startup and SSH\n\nThere are two \"providers\" for Vagrant with slightly different instructions.\nFollow one of the following two options:\n\n**VirtualBox Provider**\n\nThe VirtualBox provider is the default Vagrant provider. Use this if you are unsure.\n\n```\nvagrant up\nvagrant ssh\n```\n\n**VMware Provider**\n\nThe VMware provider is a commercial addon from Hashicorp that offers better stability and speed.\nIf you use this provider follow these instructions.\n\nVMware Fusion:\n```\nvagrant up --provider vmware_fusion\nvagrant ssh\n```\n\nVMware Workstation:\n```\nvagrant up --provider vmware_workstation\nvagrant ssh\n```\n\n``vagrant up`` triggers vagrant to download the CoreOS image (if necessary) and (re)launch the instance\n\n``vagrant ssh`` connects you to the virtual machine.\nConfiguration is stored in the directory so you can always return to this machine by executing vagrant ssh from the directory where the Vagrantfile was located.\n\n4) Get started [using CoreOS][using-coreos]\n\n[virtualbox]: https://www.virtualbox.org/\n[vagrant]: https://www.vagrantup.com/downloads.html\n[using-coreos]: http://coreos.com/docs/using-coreos/\n\n#### Shared Folder Setup\n\nThere is optional shared folder setup.\nYou can try it out by adding a section to your Vagrantfile like this.\n\n```\nconfig.vm.network \"private_network\", ip: \"172.17.8.150\"\nconfig.vm.synced_folder \".\", \"/home/core/share\", id: \"core\", :nfs =\u003e true,  :mount_options   =\u003e ['nolock,vers=3,udp']\n```\n\nAfter a 'vagrant reload' you will be prompted for your local machine password.\n\n#### Provisioning with Ignition (VirtualBox Provider (default))\n\nWhen using the VirtualBox provider for Vagrant (the default), Ignition is used to provision the machine. This uses a special plugin that is\nautomatically installed when using the default Vagrantfile. The config options for the plugin are all prefixed with `config.ignition` and can\nbe found in this Vagrantfile or in the README of the [plugin](https://github.com/coreos/vagrant-ignition)\n\nTo get started, run `curl https://discovery.etcd.io/new\\?size\\=X`, where `X` is the number of servers in your cluster (if a size is not provided,\nthe default of 3 will be used). Then, replace `\u003ctoken\u003e` in the `cl.conf` file with the generated token from the curl command. More configuration may be added if necessary. Then, use config transpiler to write the Ignition config\nto config.ign by running `ct --platform=vagrant-virtualbox \u003c cl.conf \u003e config.ign`. To see all available configuration options, check out\nthe [Container Linux Configuration Specification][clspec] as well as the [Container Linux Config Transpiler Getting Started Documentation][ignition].\nThere is also a basic Ignition file provided based on the Container Linux config that is included. To use that instead (not recommended),\ncopy `config.ign.sample` to `config.ign` and make any necessary modifications. Check out the [Ignition Getting Started documentation][ignition] \nto learn about the available features.\n\n[ignition]: https://github.com/coreos/docs/blob/master/os/provisioning.md\n[clspec]: https://github.com/coreos/container-linux-config-transpiler/blob/master/doc/configuration.md\n\n#### Provisioning with user-data (VMWare provider)\n\nWhen using the VMWare provider for Vagrant, the Vagrantfile will provision your CoreOS VM(s)\nwith [coreos-cloudinit][coreos-cloudinit] if a `user-data` file is found in the project directory. coreos-cloudinit simplifies the\nprovisioning process through the use of a script or cloud-config document.\n\nTo get started, copy `user-data.sample` to `user-data` and make any necessary modifications.\nCheck out the [coreos-cloudinit documentation][coreos-cloudinit] to learn about the available features.\n\n[coreos-cloudinit]: https://github.com/coreos/coreos-cloudinit\n\n#### Configuration\n\nThe Vagrantfile will parse a `config.rb` file containing a set of options used to configure your CoreOS cluster.\nSee `config.rb.sample` for more information.\n\n## Cluster Setup\n\nLaunching a CoreOS cluster on Vagrant is as simple as configuring `$num_instances` in a `config.rb` file to 3 (or more!) and running `vagrant up`.\nIf using the VirtualBox provider (default), copy the make sure to create a `config.ign` as described above so that the machines can be configured with\netcd and flanneld correctly. Also, make sure to provide a fresh discovery URL in your `config.ign` file to bootstrap etcd in your cluster.\nIf you are using the VMWare provider, make sure you provide a fresh discovery URL in your `user-data` if you wish to bootstrap etcd in your cluster.\n\n## New Box Versions\n\nCoreOS is a rolling release distribution and versions that are out of date will automatically update.\nIf you want to start from the most up to date version you will need to make sure that you have the latest box file of CoreOS. You can do this by running\n```\nvagrant box update\n```\n\n\n## Docker Forwarding\n\nBy setting the `$expose_docker_tcp` configuration value you can forward a local TCP port to docker on\neach CoreOS machine that you launch. The first machine will be available on the port that you specify\nand each additional machine will increment the port by 1.\n\nFollow the [Enable Remote API instructions][coreos-enabling-port-forwarding] to get the CoreOS VM setup to work with port forwarding.\n\n[coreos-enabling-port-forwarding]: https://coreos.com/docs/launching-containers/building/customizing-docker/#enable-the-remote-api-on-a-new-socket\n\nThen you can then use the `docker` command from your local shell by setting `DOCKER_HOST`:\n\n    export DOCKER_HOST=tcp://localhost:2375\n\n## Troubleshooting\nIf vagrant fails to run successfully, first make sure that the latest version of the coreos-vagrant project has been downloaded, then run\n`vagrant destroy -f` to remove old machines, `vagrant box update` to update the OS box, and `vagrant plugin update vagrant-ignition` to\nupdate the ignition plugin. If the problems persist after that, please report bugs at https://issues.coreos.com.\n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fcoreos-vagrant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoreos%2Fcoreos-vagrant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fcoreos-vagrant/lists"}