This repository has been archived by the owner on Feb 5, 2020. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3318 from enxebre/readme-t1
update readme
- Loading branch information
Showing
2 changed files
with
112 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| # Tectonic Installer | ||
|
|
||
| Tectonic is built on pure-upstream Kubernetes but has an opinion on the best way to install and run a Kubernetes cluster. This project helps you install Tectonic Kubernetes clusters. It provides good defaults, enables install automation, and is customizable to meet your infrastructure needs. | ||
|
|
||
| Goals of the project: | ||
|
|
||
| - Install Tectonic Kubernetes clusters | ||
| - Secure by default (uses TLS, RBAC by default, OIDC AuthN, etcd) | ||
| - Automatable install process for scripts and CI/CD | ||
| - Deploy on any infrastructure: Amazon AWS, Microsoft Azure, OpenStack, Google Cloud, bare metal | ||
| - Run on any OS: Container Linux (the default), [RHEL][rhel-installation] | ||
| - Customizable and modular: Change DNS providers, security settings, authentication providers | ||
| - Highly Available by default: Deploy all Kubernetes components HA | ||
|
|
||
| ## Getting Started | ||
|
|
||
| **To use a tested release** on a supported platform, follow the links below. | ||
|
|
||
| **To hack or modify** the templates or add a new platform, use the scripts in this repo to boot and tear down clusters. | ||
|
|
||
| ### Official releases | ||
|
|
||
| See the official Tectonic documentation: | ||
|
|
||
| - [AWS using a GUI](https://coreos.com/tectonic/docs/latest/install/aws/) [[**stable**][platform-lifecycle]] | ||
| - [AWS using Terraform CLI](https://coreos.com/tectonic/docs/latest/install/aws/aws-terraform.html) [[**stable**][platform-lifecycle]] | ||
| - [Azure using Terraform](https://coreos.com/tectonic/docs/latest/install/azure/azure-terraform.html) [[**stable**][platform-lifecycle]] | ||
| - [Bare metal using a GUI](https://coreos.com/tectonic/docs/latest/install/bare-metal/) [[**stable**][platform-lifecycle]] | ||
| - [Bare metal using Terraform CLI](https://coreos.com/tectonic/docs/latest/install/bare-metal/metal-terraform.html) [[**stable**][platform-lifecycle]] | ||
|
|
||
| ### Hacking | ||
|
|
||
| These instructions can be used for the official stable platforms listed above, and for the following alpha/beta platforms: | ||
|
|
||
| - [OpenStack via Terraform][openstack-tf] [[**alpha**][platform-lifecycle]] | ||
| - [VMware via Terraform][vmware-tf] [[**alpha**][platform-lifecycle]] | ||
|
|
||
| **Go and Source** | ||
|
|
||
| [Install Go](https://golang.org/doc/install) if not already installed. | ||
|
|
||
| Then get the Tectonic Installer source code: | ||
|
|
||
| ``` | ||
| go get github.com/coreos/tectonic-installer | ||
| cd $(go env GOPATH)/src/github.com/coreos/tectonic-installer | ||
| ``` | ||
|
|
||
| **Terraform** | ||
|
|
||
| The Tectonic Installer releases include a build of [Terraform](https://terraform.io). See the [Tectonic Installer release notes][release-notes] for information about which Terraform versions are compatible. | ||
|
|
||
| The [latest Terraform binary](https://www.terraform.io/downloads.html) may not always work as Tectonic Installer, which sometimes relies on bug fixes or features not yet available in the official Terraform release. | ||
|
|
||
| **Yarn (optional)** | ||
|
|
||
| The [Yarn](https://yarnpkg.com) JavaScript package manager is required for building the frontend code. On OS X, install using Homebrew: `brew install yarn`. | ||
|
|
||
| #### Common Usage | ||
|
|
||
| **Choose your platform** | ||
|
|
||
| First, set the `PLATFORM=` environment variable. This example will use `PLATFORM=azure`. | ||
|
|
||
| - `PLATFORM=openstack` [OpenStack via Terraform][openstack-tf] [[**alpha**][platform-lifecycle]] | ||
| - `PLATFORM=vmware` [VMware via Terraform][vmware-tf] [[**alpha**][platform-lifecycle]] | ||
|
|
||
| **Initiate the Cluster Configuration** | ||
|
|
||
| Use `make` to create a new directory `build/<cluster-name>` to hold all module references, Terraform state files, and custom variable files. | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make localconfig | ||
| ``` | ||
|
|
||
| **Configure Cluster** | ||
|
|
||
| Set variables in the `build/<cluster-name>/terraform.tfvars` file as needed. Available variables are found in the `platforms/<PLATFORM>/config.tf` and `platforms/<PLATFORM>/variables.tf` files. | ||
|
|
||
| Examples for each platform can be found in [the examples directory](examples/). | ||
|
|
||
| **Terraform Lifecycle** | ||
|
|
||
| `plan`, `apply`, and `destroy` are provided as `make` targets to ease the build directory and custom binary complexity. | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make plan | ||
| ``` | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make apply | ||
| ``` | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make destroy | ||
| ``` | ||
|
|
||
| #### Tests | ||
|
|
||
| See [tests/README.md](tests/README.md). | ||
|
|
||
|
|
||
| [openstack-tf]: https://github.com/coreos/tectonic-docs/blob/master/Documentation/install/openstack/openstack-terraform.md | ||
| [platform-lifecycle]: https://coreos.com/tectonic/docs/latest/platform-lifecycle.html | ||
| [release-notes]: https://coreos.com/tectonic/releases/ | ||
| [rhel-installation]: https://coreos.com/tectonic/docs/latest/install/rhel/installing-workers.html | ||
| [vmware-tf]: https://github.com/coreos/tectonic-docs/blob/master/Documentation/install/vmware/vmware-terraform.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,109 +1,10 @@ | ||
| # Tectonic Installer | ||
|
|
||
| Tectonic is built on pure-upstream Kubernetes but has an opinion on the best way to install and run a Kubernetes cluster. This project helps you install a Kubernetes cluster the "Tectonic Way". It provides good defaults, enables install automation, and is customizable to meet your infrastructure needs. | ||
| The CoreOS and OpenShift teams are now working together to integrate Tectonic and Open Shift into a converged platform which will be developed in https://github.com/openshift/installer. We'll consider all feature requests for the new converged platform, but will not be adding new features to _this_ repository. | ||
|
|
||
| Goals of the project: | ||
| In the meantime, current Tectonic customers will continue to receive support and updates. Any such bugfixes will take place on the [track-1](https://github.com/coreos/tectonic-installer/tree/track-1) branch. | ||
|
|
||
| - Install Kubernetes clusters | ||
| - Secure by default (uses TLS, RBAC by default, OIDC AuthN, etcd) | ||
| - Automatable install process for scripts and CI/CD | ||
| - Deploy on any infrastructure: Amazon AWS, Microsoft Azure, OpenStack, Google Cloud, bare metal | ||
| - Run on any OS: Container Linux (the default), [RHEL][rhel-installation], Ubuntu, and others | ||
| - Customizable and modular: Change DNS providers, security settings, authentication providers | ||
| - Highly Available by default: Deploy all Kubernetes components HA, use etcd Operator | ||
| See the CoreOS blog for any additional details: | ||
| https://coreos.com/blog/coreos-tech-to-combine-with-red-hat-openshift | ||
|
|
||
| Check the [ROADMAP](ROADMAP.md) for details on where the project is headed. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| **To use a tested release** on a supported platform, follow the links below. | ||
|
|
||
| **To hack or modify** the templates or add a new platform, use the scripts in this repo to boot and tear down clusters. | ||
|
|
||
| ### Official releases | ||
|
|
||
| See the official Tectonic documentation: | ||
|
|
||
| - [AWS using a GUI](https://coreos.com/tectonic/docs/latest/install/aws/) [[**stable**][platform-lifecycle]] | ||
| - [AWS using Terraform CLI](https://coreos.com/tectonic/docs/latest/install/aws/aws-terraform.html) [[**stable**][platform-lifecycle]] | ||
| - [Azure using Terraform](https://coreos.com/tectonic/docs/latest/install/azure/azure-terraform.html) [[**stable**][platform-lifecycle]] | ||
| - [Bare metal using a GUI](https://coreos.com/tectonic/docs/latest/install/bare-metal/) [[**stable**][platform-lifecycle]] | ||
| - [Bare metal using Terraform CLI](https://coreos.com/tectonic/docs/latest/install/bare-metal/metal-terraform.html) [[**stable**][platform-lifecycle]] | ||
|
|
||
| ### Hacking | ||
|
|
||
| These instructions can be used for the official stable platforms listed above, and for the following alpha/beta platforms: | ||
|
|
||
| - [OpenStack via Terraform][openstack-tf] [[**alpha**][platform-lifecycle]] | ||
| - [VMware via Terraform][vmware-tf] [[**alpha**][platform-lifecycle]] | ||
|
|
||
| **Go and Source** | ||
|
|
||
| [Install Go](https://golang.org/doc/install) if not already installed. | ||
|
|
||
| Then get the Tectonic Installer source code: | ||
|
|
||
| ``` | ||
| go get github.com/coreos/tectonic-installer | ||
| cd $(go env GOPATH)/src/github.com/coreos/tectonic-installer | ||
| ``` | ||
|
|
||
| **Terraform** | ||
|
|
||
| The Tectonic Installer releases include a build of [Terraform](https://terraform.io). See the [Tectonic Installer release notes][release-notes] for information about which Terraform versions are compatible. | ||
|
|
||
| The [latest Terraform binary](https://www.terraform.io/downloads.html) may not always work as Tectonic Installer, which sometimes relies on bug fixes or features not yet available in the official Terraform release. | ||
|
|
||
| **Yarn (optional)** | ||
|
|
||
| The [Yarn](https://yarnpkg.com) JavaScript package manager is required for building the frontend code. On OS X, install using Homebrew: `brew install yarn`. | ||
|
|
||
| #### Common Usage | ||
|
|
||
| **Choose your platform** | ||
|
|
||
| First, set the `PLATFORM=` environment variable. This example will use `PLATFORM=azure`. | ||
|
|
||
| - `PLATFORM=openstack` [OpenStack via Terraform][openstack-tf] [[**alpha**][platform-lifecycle]] | ||
| - `PLATFORM=vmware` [VMware via Terraform][vmware-tf] [[**alpha**][platform-lifecycle]] | ||
|
|
||
| **Initiate the Cluster Configuration** | ||
|
|
||
| Use `make` to create a new directory `build/<cluster-name>` to hold all module references, Terraform state files, and custom variable files. | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make localconfig | ||
| ``` | ||
|
|
||
| **Configure Cluster** | ||
|
|
||
| Set variables in the `build/<cluster-name>/terraform.tfvars` file as needed. Available variables are found in the `platforms/<PLATFORM>/config.tf` and `platforms/<PLATFORM>/variables.tf` files. | ||
|
|
||
| Examples for each platform can be found in [the examples directory](examples/). | ||
|
|
||
| **Terraform Lifecycle** | ||
|
|
||
| `plan`, `apply`, and `destroy` are provided as `make` targets to ease the build directory and custom binary complexity. | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make plan | ||
| ``` | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make apply | ||
| ``` | ||
|
|
||
| ``` | ||
| PLATFORM=azure CLUSTER=my-cluster make destroy | ||
| ``` | ||
|
|
||
| #### Tests | ||
|
|
||
| See [tests/README.md](tests/README.md). | ||
|
|
||
|
|
||
| [openstack-tf]: https://github.com/coreos/tectonic-docs/blob/master/Documentation/install/openstack/openstack-terraform.md | ||
| [platform-lifecycle]: https://coreos.com/tectonic/docs/latest/platform-lifecycle.html | ||
| [release-notes]: https://coreos.com/tectonic/releases/ | ||
| [rhel-installation]: https://coreos.com/tectonic/docs/latest/install/rhel/installing-workers.html | ||
| [vmware-tf]: https://github.com/coreos/tectonic-docs/blob/master/Documentation/install/vmware/vmware-terraform.md | ||
| *Note*: The master branch of the project reflects a work-in-progress design approach works only on AWS and Libvirt. In order to deploy Tectonic to other platforms, e.g. Azure, bare metal, OpenStack, etc, please checkout the [track-1](https://github.com/coreos/tectonic-installer/tree/track-1) branch of this project, which maintains support for the previous architecture and more platforms. |