{"id":18302306,"url":"https://github.com/outscale/docker-machine-driver-outscale","last_synced_at":"2025-04-05T14:31:27.902Z","repository":{"id":37309144,"uuid":"433483970","full_name":"outscale/docker-machine-driver-outscale","owner":"outscale","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-19T02:02:05.000Z","size":141,"stargazers_count":0,"open_issues_count":3,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-21T05:43:09.794Z","etag":null,"topics":["maturity-sandbox"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-11-30T15:30:15.000Z","updated_at":"2025-03-21T05:03:26.000Z","dependencies_parsed_at":"2023-07-12T22:50:38.413Z","dependency_job_id":null,"html_url":"https://github.com/outscale/docker-machine-driver-outscale","commit_stats":null,"previous_names":["outscale-dev/docker-machine-driver-outscale"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fdocker-machine-driver-outscale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fdocker-machine-driver-outscale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fdocker-machine-driver-outscale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fdocker-machine-driver-outscale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/docker-machine-driver-outscale/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247352631,"owners_count":20925307,"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":["maturity-sandbox"],"created_at":"2024-11-05T15:19:08.114Z","updated_at":"2025-04-05T14:31:25.584Z","avatar_url":"https://github.com/outscale.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-machine-driver-outscale\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/outscale-dev/docker-machine-driver-outscale)](https://goreportcard.com/report/github.com/outscale-dev/docker-machine-driver-outscale)\n[![GitHub release](https://img.shields.io/github/release/outscale-dev/docker-machine-driver-outscale.svg)](https://github.com/outscale-dev/docker-machine-driver-outscale/releases/)\n[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)\n\nOutscale Driver plugin for docker-machine\n\n## Install\nIf you would rather build from source, you will need to have a working `go` 1.17+ environment,\n\n```bash\neval $(go env)\nexport PATH=\"$PATH:$GOPATH/bin\"\n```\n\nYou can then install `docker-machine` from source by running:\n\n```bash\ngo get github.com/docker/machine\ncd $GOPATH/src/github.com/docker/machine\nmake build\n```\n\nAnd then compile the `docker-machine-driver-outscale` driver:\n\n```bash\ngo get github.com/outscale-dev/docker-machine-driver-outscale\ncd $GOPATH/src/github.com/outscale-dev/docker-machine-driver-outscale\nmake install\n```\n\n## Run\nIn order to create a machine, you will need to have you AK/SK . You can find information here: [Documentation](https://docs.outscale.com/en/userguide/Getting-Information-About-Your-Access-Keys.html)\n\n```bash\ndocker-machine create -d outscale --outscale-access-key=\u003coutscale-access-key\u003e  --outscale-secret-key=\u003coutscale-secret-key\u003e --outscale-region=\u003coutscale-region\u003e outscale\n```\n\n### Options\n| Argument | Env | Default | Description\n| --- | --- | --- | ---\n| `outscale-access-key` | `OUTSCALE_ACCESS_KEY\\|OSC_ACCESS_KEY` | None | **required** Outscale Access Key (see [here](https://docs.outscale.com/en/userguide/Getting-Information-About-Your-Access-Keys.html))\n| `outscale-secret-key` | `OUTSCALE_SECRET_KEY\\|OSC_SECRET_KEY` | None | **required** Outscale Secret Key (see [here](https://docs.outscale.com/en/userguide/Getting-Information-About-Your-Access-Keys.html))\n| `outscale-region` | `OUTSCALE_REGION\\|OSC_REGION` | eu-west-2 | Outscale Region\n| `outscale-instance-type` | `OUTSCALE_INSTANCE_TYPE` | tinav2.c1r2p3 (t2.small) | Outscale VM Instance Type (see [here](https://docs.outscale.com/en/userguide/Instance-Types.html))\n| `outscale-source-omi`    | `OUTSCALE_SOURCE_OMI`    | ami-2cf1fa3e (Debian-10-2021.05.12-3) | Outscale Machine Image to use as bootstrap for the VM (see [here](https://docs.outscale.com/en/userguide/Official-OMIs-Reference.html#_supported_official_images)) |\n| `outscale-extra-tags-all` | `` | nil| Extra tags for all created resources. Format \"key=value\". Can be set multiple times\n| `outscale-extra-tags-instances` | `` | nil | Extra tags only for instances. Format \"key=value\". Can be set multiple times\n| `outscale-security-group-ids` | `` | nil | Ids of user defined Security Groups to add to the machine. Can be set multiple times\n| `outscale-root-disk-type` | `` | gp2 | Type of volume for the root disk ('standard', 'io1' or 'gp2')\n| `outscale-root-disk-size` | `` | 15 | Size of the root disk in GB (\u003e 0)\n| `outscale-root-disk-iops` | `` | 1500 | Iops for the io1 root disk type (ignore if it is not io1). Value between 1 and 13000.\n| `outscale-subnet-id` | `` | `` | Id of the Net use to create all resources when a private network is requested.\n| `outscale-kubernetes-node-name-autotag` | `` | false | Automatically add kubernetes tag 'OscK8sNodeName' to the instance (Useful for the CCM).\n\n\n## Security group\nIf no Security group is provided, a security group will be created with theses rules\n| Type | Protocol | From Port | To Port | CIDR | Description\n| --- | --- | --- | --- | --- | ---\n| Inbound | TCP | 22 | 22 | 0.0.0.0/0 | SSH\n| Inbound | TCP | 80 | 80 | 0.0.0.0/0 | nginx Ingress Http\n| Inbound | TCP | 443 | 443 | 0.0.0.0/0 | nginx Ingress Https\n| Inbound | TCP | 2376 | 2376 | 0.0.0.0/0 | Docker daemon\n| Inbound | TCP | 2379 | 2380 | 0.0.0.0/0 | ETCD (client request and peer communication)\n| Inbound | TCP | 6443 | 6443 | 0.0.0.0/0 | Kube-api \n| Inbound | TCP | 10250 | 10250 | 0.0.0.0/0 | Kubelet\n| Inbound | TCP | 10251 | 10251 | 0.0.0.0/0 | Kube-scheduler\n| Inbound | TCP | 10252 | 10252 | 0.0.0.0/0 | Kube-controller-manager\n| Inbound | TCP | 10256 | 10256 | 0.0.0.0/0 | Kube-proxy\n| Inbound | TCP | 30000 | 32767 | 0.0.0.0/0 | Node port\n| Inbound | UDP | 30000 | 32767 | 0.0.0.0/0 | Node port\n| Inbound | UDP | 8472 | 8472 | 0.0.0.0/0 | Canal/Flannel overlay\n| Inbound | UDP | 4789 | 4789 | 0.0.0.0/0 | Canal/Flannel overlay\n\nIn the example section, there are some exampe of minimal Security Group preprovisionned for different use-cased:\n- [Rancher Cluster with calico network](example/calico/README.md)\n- [Rancher Cluster with canal network](example/canal/README.md)\n\n## Debugging\nDetailed run output will be emitted when using  the `docker-machine` `--debug` option.\n\n```bash\ndocker-machine --debug  create -d outscale --outscale-access-key=\u003coutscale-access-key\u003e  --outscale-secret-key=\u003coutscale-secret-key\u003e --outscale-region=\u003coutscale-region\u003e outscale\n```\n\n## License\n\n\u003e Copyright Outscale SAS\n\u003e\n\u003e BSD-3-Clause\n\nThis project is compliant with [REUSE](https://reuse.software/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fdocker-machine-driver-outscale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fdocker-machine-driver-outscale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fdocker-machine-driver-outscale/lists"}