openshift/installer
1
0
Fork 0
mirror of https://github.com/openshift/installer.git synced 2026-02-05 06:46:36 +01:00
Code Issues Releases Activity
Files
55037565649ca70cdd66a5ccafbe44656d9374c6
installer/README.md

64 lines
3.5 KiB
Markdown
Raw Normal View History

README.md: Pedantic capitalization nit. s/Openshift/OpenShift/
2018-12-11 13:49:55 -05:00
# OpenShift Installer
Update README with travis run output banner
2018-06-19 15:25:45 +02:00
README.md: Document supported platforms. List the supported platforms in the README. I wanted to note that the OpenStack support is still experimental and needs more work and didn't see an obvious other place to do that.
2018-10-02 22:39:18 -04:00
## Supported Platforms
CORS-3830: Add missing supported platforms in top-level README (#9408) * docs: remove ovirt from supported platforms * docs: add ibmcloud, nutanix, and powervs as supported platform * docs: reorganized and added powervs upi * docs: remove libvirt from supported list * docs: include official docs for supported platforms and deduplication
2025-01-29 12:45:47 -08:00
* [AWS](docs/user/aws/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_aws/preparing-to-install-on-aws.html))
* [Azure](docs/user/azure/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_azure/preparing-to-install-on-azure.html))
* [Bare Metal](docs/user/metal/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_bare_metal/preparing-to-install-on-bare-metal.html))
* [GCP](docs/user/gcp/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_gcp/preparing-to-install-on-gcp.html))
* IBM Cloud ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_ibm_cloud/preparing-to-install-on-ibm-cloud.html))
* Nutanix ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_nutanix/preparing-to-install-on-nutanix.html))
* [OpenStack](docs/user/openstack/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_openstack/preparing-to-install-on-openstack.html))
* [Power](docs/user/power/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_ibm_power/preparing-to-install-on-ibm-power.html))
* Power VS ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.html))
* [vSphere](docs/user/vsphere/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_vsphere/preparing-to-install-on-vsphere.html))
* [z/VM](docs/user/zvm/) ([Official Docs](https://docs.openshift.com/container-platform/latest/installing/installing_ibm_z/preparing-to-install-on-ibm-z.html))
README.md: Document supported platforms. List the supported platforms in the README. I wanted to note that the OpenStack support is still experimental and needs more work and didn't see an obvious other place to do that.
2018-10-02 22:39:18 -04:00
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
## Quick Start
update README
2018-07-04 10:12:36 +02:00
docs/libvirt-howto: Add dependency installation. Add a few things to the libvirt howto after my first pass running it: - Add dependency installation - Start libvirtd - Show how to create the default libvirt storage pool - Renumber sections after inserting new sections - Fix rhcos image name - Clarify that when running the --permanent commands for firewalld are in addition to running the same commands without the flag - change reference to ../libvirt.yaml to libvirt.yaml to match where the file will be based on past instructions
2018-09-24 14:18:29 -04:00
First, install all [build dependencies](docs/dev/dependencies.md).
docs(README): README build steps don't require clone to GOPATH Fix documentation to no longer reflect needless requirement of cloning the installer repository to a directory in $GOPATH/src. [issue #3422] * Tags: kind/documentation platform/none size/XS
2020-04-07 10:51:02 -05:00
Clone this repository. Then build the `openshift-install` binary with:
update README
2018-07-04 10:12:36 +02:00
docs: Consistent sh vs. console syntax highlighting GitHub uses Linuguist for syntax highlighting [1], and Linuguist defines two related grammars: * Shell (alias 'sh') [2], which applies to POSIX and similar shell languages. * ShellSession (alias 'console') [3], which extends the Shell grammar with support for prompts and command output as you would usually see in an interactive shell session. This commit consistently uses 'sh' to highlight blocks which contain only shell commands (without prompts or output). And it uses 'console' to highlight blocks which contain prompts, commands, and output. I've also removed prompts blocks which contain no output, because in the no-output cases that approach seemed more popular within this repository. I've also standardised on the 'sh' alias, where this repository previously used both 'sh' and 'shell'. I've also added continuation prompts (PS2) to the long describe-auto-scaling-groups example, to keep the continued command from being marked up as output. And I've replaced the terminal \ continuation there with a terminal |; we need a pipe anyway so we might as well save a character ;). [1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting [2]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4317-L4378 [3]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4379-L4390
2018-07-06 13:44:51 -07:00
```sh
README.md: fix path to build.sh
2018-09-26 15:33:14 -04:00
hack/build.sh
update README
2018-07-04 10:12:36 +02:00
```
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
This will create `bin/openshift-install`. This binary can then be invoked to create an OpenShift cluster, like so:
README: add some more color and info
2017-02-28 08:38:24 -08:00
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
```sh
cmd/openshift-install: Push creation under 'openshift create' To mirror 'openshift-install destroy' and make it easier for folks using multiple invocations to see what their options are. I've deprecated all the old commands, and am looking forward to dropping them as soon as possible :).
2018-10-22 13:58:17 -07:00
bin/openshift-install create cluster
docs: rework documentation This updates the documentation to reflect the new installer.
2018-09-24 16:28:46 -07:00
```
README: Document ~/.aws/credentials requirement To avoid 'tectonic install' dying with [1]: provider.aws: NoCredentialProviders: no valid providers in chain. Deprecated I'd prefer to switch to Markdown's lazy list numbering [2], so future step injections don't have to renumber anything. But Alex prefers non-lazy numbering despite the churn, to make reading the Markdown a bit easier [3]. [1]: https://github.com/terraform-providers/terraform-provider-aws/issues/5044 [2]: https://daringfireball.net/projects/markdown/syntax#list [3]: https://github.com/openshift/installer/pull/57#discussion_r202756972
2018-07-13 13:11:10 -07:00
README: Replace stale environment variable reference Catching up with 6be4c253 (*: remove support for environment variables, 2018-12-10, #861). Also link to the troubleshooting docs, since the easier it is to discover those, the fewer bug reports we'll get with insufficient detail ;).
2018-12-17 23:16:03 -08:00
The installer will show a series of prompts for user-specific information and use reasonable defaults for everything else.
In non-interactive contexts, prompts can be bypassed by [providing an `install-config.yaml`](docs/user/overview.md#multiple-invocations).
If you have trouble, refer to [the troubleshooting guide](docs/user/troubleshooting.md).
README: Add console and cleanup information This restores the console docs which we'd removed from the README in feb41e9d (docs: rework documentation, 2018-09-24, #328). And it moves the kubeconfig location information over from the libvirt-specific docs. Launching the cluster is nice, but these other operations are important too ;). Putting them in the README makes increases their visibility. It also lets us drom them from the libvirt-specific docs, now that the libvirt docs link to the README quick-start for these generic operations.
2018-10-02 22:01:36 -07:00
### Connect to the cluster
Replace information with example CLI output
2018-12-10 12:47:20 -05:00
Details for connecting to your new cluster are printed by the `openshift-install` binary upon completion, and are also available in the `.openshift_install.log` file.
README: Add console and cleanup information This restores the console docs which we'd removed from the README in feb41e9d (docs: rework documentation, 2018-09-24, #328). And it moves the kubeconfig location information over from the libvirt-specific docs. Launching the cluster is nice, but these other operations are important too ;). Putting them in the README makes increases their visibility. It also lets us drom them from the libvirt-specific docs, now that the libvirt docs link to the README quick-start for these generic operations.
2018-10-02 22:01:36 -07:00
Replace information with example CLI output
2018-12-10 12:47:20 -05:00
Example output:
README: Add console and cleanup information This restores the console docs which we'd removed from the README in feb41e9d (docs: rework documentation, 2018-09-24, #328). And it moves the kubeconfig location information over from the libvirt-specific docs. Launching the cluster is nice, but these other operations are important too ;). Putting them in the README makes increases their visibility. It also lets us drom them from the libvirt-specific docs, now that the libvirt docs link to the README quick-start for these generic operations.
2018-10-02 22:01:36 -07:00
```sh
Replace information with example CLI output
2018-12-10 12:47:20 -05:00
INFO Waiting 10m0s for the openshift-console route to be created...
INFO Install complete!
Print the "export KUBECONFIG=..." command on its own line for easier cut-and-paste
2022-03-17 10:58:50 -04:00
INFO To access the cluster as the system:admin user when using 'oc', run
export KUBECONFIG=/path/to/installer/auth/kubeconfig
docs: Drop 'OPENSHIFT_INSTALL_' prefix The long forms are less likely to exist in the user's environment since 6be4c253 (*: remove support for environment variables, 2018-12-10, #861), and we no longer need the context to distinguish from all the other environment variables on a user's system.
2018-12-12 20:47:35 -08:00
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.${CLUSTER_NAME}.${BASE_DOMAIN}:6443
Replace information with example CLI output
2018-12-10 12:47:20 -05:00
INFO Login to the console with user: kubeadmin, password: 5char-5char-5char-5char
README: Add console and cleanup information This restores the console docs which we'd removed from the README in feb41e9d (docs: rework documentation, 2018-09-24, #328). And it moves the kubeconfig location information over from the libvirt-specific docs. Launching the cluster is nice, but these other operations are important too ;). Putting them in the README makes increases their visibility. It also lets us drom them from the libvirt-specific docs, now that the libvirt docs link to the README quick-start for these generic operations.
2018-10-02 22:01:36 -07:00
```
### Cleanup
Destroy the cluster and release associated resources with:
```sh
cmd/openshift-install: Add 'destroy bootstrap' command Using Terraform to remove all resources created by the bootstrap modules. For this to work, all platforms must define a bootstrap module (and they all currently do). This command moves the previous destroy-cluster into a new 'destroy cluster' subcommand, because grouping different destroy flavors into sub-commands makes the base command easier to understand. We expect both destroy flavors to be long-running, because it's hard to write generic logic for "is the cluster sufficiently live for us to remove the bootstrap". We don't want to hang forever if the cluster dies before coming up, but there's no solid rules for how long to wait before deciding that it's never going to come up. When we start destroying the bootstrap resources automatically in the future, will pick reasonable timeouts, but will want to still provide callers with the ability to manually remove the bootstrap resources if we happen to fall out of that timeout on a cluster that does eventually come up. I've also created a LoadMetadata helper to share the "retrieve the metadata from the asset directory" logic between the destroy-cluster and destroy-bootstrap logic. The new helper lives in the cluster asset plackage close to the code that determines that file's location. I've pushed the Terraform module unpacking and 'terraform init' call down into a helper used by the Apply and Destroy functions to make life easier on the callers. I've also fixed a path.Join -> filepath.Join typo in Apply, which dates back to ff5a57b0 (pkg/terraform: Modify some helper functions for the new binary layout, 2018-09-19, #289). These aren't network paths ;).
2018-10-18 22:29:51 -07:00
openshift-install destroy cluster
README: Add console and cleanup information This restores the console docs which we'd removed from the README in feb41e9d (docs: rework documentation, 2018-09-24, #328). And it moves the kubeconfig location information over from the libvirt-specific docs. Launching the cluster is nice, but these other operations are important too ;). Putting them in the README makes increases their visibility. It also lets us drom them from the libvirt-specific docs, now that the libvirt docs link to the README quick-start for these generic operations.
2018-10-02 22:01:36 -07:00
```
README: Add more hints about cleanup and reinstallation The stale `auth` directory was what was breaking my cluster reinstalls. Let's encourage people to use `--dir`.
2018-10-24 17:44:49 -04:00
Note that you almost certainly also want to clean up the installer state files too, including `auth/`, `terraform.tfstate`, etc.
README: change install to create there is no install command, the command is create Signed-off-by: Vadim Eisenberg <vadime@il.ibm.com>
2021-03-12 17:19:06 +02:00
The best thing to do is always pass the `--dir` argument to `create` and `destroy`.
README: Add more hints about cleanup and reinstallation The stale `auth` directory was what was breaking my cluster reinstalls. Let's encourage people to use `--dir`.
2018-10-24 17:44:49 -04:00
And if you want to reinstall from scratch, `rm -rf` the asset directory beforehand.
Copy Permalink