diff --git a/CHANGELOG.md b/CHANGELOG.md index 75539521c3..5b2c039b74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -963,7 +963,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - etcd discovery now happens via `SRV` records. On libvirt, this requires a new Terraform provider, so users with older providers should [install a newer - version](docs/dev/libvirt-howto.md#install-the-terraform-provider). + version](docs/dev/libvirt/README.md#install-the-terraform-provider). This also allows all masters to use a single Ignition file. - On AWS, the API and service load balancers have been changed from [classic load balancers][aws-elb] to [network load @@ -1162,7 +1162,7 @@ The configuration and command-line interface are quite different, so previous `tectonic` users are encouraged to start from scratch when getting acquainted with `openshift-install`. AWS users should look [here](README.md#quick-start). Libvirt users should look -[here](docs/dev/libvirt-howto.md). The new `openshift-install` also +[here](docs/dev/libvirt/README.md). The new `openshift-install` also includes an interactive configuration generator, so you can launch the installer and follow along as it guides you through the process. diff --git a/README.md b/README.md index e0a96c53fb..91b5f15758 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Supported Platforms * [AWS](docs/user/aws/README.md) -* [Libvirt with KVM](docs/dev/libvirt-howto.md) (development only) +* [Libvirt with KVM](docs/dev/libvirt/README.md) (development only) * [OpenStack (experimental)](docs/user/openstack/README.md) ## Quick Start diff --git a/docs/dev/dependencies.md b/docs/dev/dependencies.md index fcba201cce..5d72639477 100644 --- a/docs/dev/dependencies.md +++ b/docs/dev/dependencies.md @@ -10,7 +10,7 @@ The following dependencies must be installed on your system before you can build sudo yum install golang-bin gcc-c++ ``` -If you need support for [libvirt destroy](libvirt-howto.md#cleanup), you should also install `libvirt-devel`. +If you need support for [libvirt destroy](libvirt/README.md#cleanup), you should also install `libvirt-devel`. ### Go diff --git a/docs/dev/libvirt-howto.md b/docs/dev/libvirt/README.md similarity index 100% rename from docs/dev/libvirt-howto.md rename to docs/dev/libvirt/README.md diff --git a/docs/dev/openstack-howto.md b/docs/dev/openstack-howto.md deleted file mode 100644 index 63ea8c7a8a..0000000000 --- a/docs/dev/openstack-howto.md +++ /dev/null @@ -1,13 +0,0 @@ -# OpenStack Development Environment - -First, see if you have access to an OpenStack cloud that meets the -[requirements](../user/openstack/README.md). If so, you may just point the -installer at that cloud. - -If you would like to set up an isolated development environment, you may use a -bare metal host running CentOS 7. The following repository includes some -instructions and scripts to help with creating a single-node OpenStack -development environment for running the installer. Please refer to the -documentation in that repository for further details. - -* https://github.com/shiftstack-dev-tools/ocp-doit diff --git a/docs/user/openstack/OWNERS b/docs/user/openstack/OWNERS new file mode 100644 index 0000000000..ea6fcb46de --- /dev/null +++ b/docs/user/openstack/OWNERS @@ -0,0 +1,5 @@ +# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md +# This file just uses aliases defined in OWNERS_ALIASES. + +approvers: + - openstack-approvers diff --git a/docs/user/openstack/README.md b/docs/user/openstack/README.md index 16f9904ee9..9b9ebca2e2 100644 --- a/docs/user/openstack/README.md +++ b/docs/user/openstack/README.md @@ -60,6 +60,16 @@ openstack network list --long -c ID -c Name -c "Router Type" +--------------------------------------+----------------+-------------+ ``` +### Isolated Development + +If you would like to set up an isolated development environment, you may use a +bare metal host running CentOS 7. The following repository includes some +instructions and scripts to help with creating a single-node OpenStack +development environment for running the installer. Please refer to the +documentation in that repository for further details. + +* https://github.com/shiftstack-dev-tools/ocp-doit + ## OpenShift API Access All the OpenShift nodes are created in an OpenStack tenant network and as such, can't be accessed directly. The installer does not create any floating IP addresses.