openstack: Update User Documentation #2218

Fedosin · 2019-08-14T15:01:06Z

No description provided.

wking · 2019-08-14T15:57:38Z

The commit/PR subject could be more specific, and should at least mention OpenStack ;)

abhinavdahiya · 2019-08-14T16:31:21Z

docs/user/openstack/README.md

+In order to determine which cloud to use, the user can either specify it in the `install-config.yaml` file under `platform.openstack.cloud` or with `OS_CLOUD` environment variable.
+If both are omitted, then the cloud name defaults to `openstack`.

+If you choose to use environment variables in place of a `clouds.yaml`, or along side it, consult the following [documentation](https://www.terraform.io/docs/providers/openstack/#configuration-reference):


I don' think we point to terraform docs specially.

cc @crawford

abhinavdahiya · 2019-08-14T16:32:32Z

docs/user/openstack/README.md

+openstack image create --container-format=bare --disk-format=qcow2 --file rhcos-${RHCOSVERSION}-openstack.qcow2 rhcos
 ```
+
+**NOTE:** Depending on your OpenStack environment you can upload the RHCOS image as `raw` or `qcow2`. See [Disk and container formats for images](https://docs.openstack.org/image-guide/image-formats.html) for more information. The installer looks for an image named `rhcos`. This could be overridden via the `OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE` environment variable if for instance your cloud operator provides the image under a different name.


This is not ideal..

cc @crawford

@abhinavdahiya can you clarify what the problem here is?

Telling users to use OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE is not ideal as that env will show users a warning that override is not supported and should only be done for development.

Can we file this as a bug in a bz, if its going to be problematic for our release, we would like to patch it

Or would you rather we simply don't give them the option to use the Override

@abhinavdahiya what is the desired way to set a different boot image in 4.2? Environment variable (as documented here) or option in the installer as implemented at #2226?

We need to come to a resolution for https://bugzilla.redhat.com/show_bug.cgi?id=1741930.

abhinavdahiya · 2019-08-14T16:35:21Z

docs/user/openstack/README.md

-```
-$ env TF_VAR_openstack_external_network_id="6a32627e-d98d-40d8-9324-5da7cf1452fc" \
+```sh
+env TF_VAR_openstack_external_network_id="6a32627e-d98d-40d8-9324-5da7cf1452fc" \


The users should not be asked to set these terraform specific envs. These should not end up in our public user documentation.

cc @crawford

This is a workaround for an edge case

If we move it to a document exclusively for workarounds, can we still have it documented

otherwise, we will file a bug report

abhinavdahiya · 2019-08-14T16:35:54Z

/hold

iamemilio · 2019-08-15T14:23:07Z

/project openstack

iamemilio · 2019-08-15T15:20:15Z

/label platform/openstack

iamemilio · 2019-08-16T14:12:30Z

@abhinavdahiya We addressed your suggestions, take a look

abhinavdahiya · 2019-08-16T19:03:34Z

docs/user/openstack/README.md

+```

-This method allows you to attach two floating IP addresses to endpoints in OpenShift.
+For the time being, the OpenStack platform is not supported in the prompts. We will instead provide you with a template `install-config.yaml` to use below. If you want to go beyond the basic customizations we display below, there is more information available in [this document](customization.md). We have labled sections in the yaml below with the following syntax: (#). Look for the numbers below the template for explanations of how to complete those sections.


Hmm, is that true??

It is with the latest 4.2 nightly. We are running a developer preview, and are trying to be as accurate to the current state of the installer as possible in the current iteration of the docs.

@abhinavdahiya

Hmm it should be the case though...
Or #2036 isn't yet in the latest nightly?

I just tried the latest nightly at https://mirror.openshift.com/pub/openshift-v4/clients/ocp-dev-preview/latest/ and it proposes OpenStack as a platform choice in the wizard. I'm suggesting we remove this section and reference the docs/user/openstack/customization.md doc instead.

mandre · 2019-08-18T07:31:36Z

docs/user/openstack/customization.md

+  platform: {}
+  replicas: 3
+compute:
+  name: worker


This should be a list.

compute: - name: worker platform: openstack: type: ml.large replicas: 3

mandre · 2019-08-18T07:37:59Z

docs/user/openstack/customization.md

+metadata:
+  name: example
+networking:
+  clusterNetworks:


clusterNetworks was renamed to clusterNetwork in v1beta4, see

installer/pkg/types/installconfig.go

Line 195 in 4e204c5

// Deprecated name for ClusterNetwork

hostSubnetLength is also deprecated.

You should instead have:

networking: clusterNetwork: - cidr: 192.168.1.0/16 hostPrefix: 23

mandre · 2019-08-18T07:38:10Z

docs/user/openstack/customization.md

+  - cidr: 192.168.1.0/16
+    hostSubnetLength: 9
+  machineCIDR: 10.0.0.0/16
+  serviceCIDR: 172.30.0.0/16


serviceCIDR should be replaced with serviceNetwork. It also now expects a list.

serviceNetwork: - 172.30.0.0/16

mandre · 2019-08-18T07:38:19Z

docs/user/openstack/customization.md

+    hostSubnetLength: 9
+  machineCIDR: 10.0.0.0/16
+  serviceCIDR: 172.30.0.0/16
+  type: OpenShiftSDN


type should be changed for networkType.

networkType: OpenShiftSDN

mandre · 2019-08-18T09:45:19Z

docs/user/openstack/README.md

-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.
+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 [this documentation](ocp-doit) for further details.


Syntax for the ocp-doit link is not good, it's rendered as a relative link.

mandre · 2019-08-18T10:32:17Z

docs/user/openstack/README.md

+
+## Destroying The Cluster
+
+Destroying the cluster has been noticed to sometimes fail. We are working on patching this, but in a mean time the workaround is to simply run it again. To do so, point it to your cluster with this command:


Please link to an open issue so that users will know when it is fixed.

mandre · 2019-08-18T10:34:08Z

docs/user/openstack/README.md

-* `openstack floating ip create --port master-port-1 <public network>`
-* `openstack floating ip create --port master-port-2 <public network>`
+```sh
+openstack floating ip create --port master-port-0 <public network>


It doesn't have to be public network. It has to be a network the external load balancer has access to though.

mandre · 2019-08-18T10:36:49Z

docs/user/openstack/README.md


-* `<load balancer ip> <cluster-name>-api.<base domain>`
+```txt
+<load balancer ip> <cluster-name>-api.<base domain>


This is not a DNS record, but a /etc/hosts format.

mandre · 2019-08-18T10:39:31Z

docs/user/openstack/README.md


-Now the DNS entry for <cluster name>-api.<base domain> needs to be updated
-to point to the new load balancer:
+Now the DNS entry for `<cluster name>-api.<base domain>` needs to be updated to point to the new load balancer:


It's api.<cluster name>.<base domain>

mandre · 2019-08-18T10:41:15Z

docs/user/openstack/README.md

+curl https://<loadbalancer ip>:22623/config/master --insecure
+```

 Now that the DNS and load balancer has been moved, we can take down the existing


API VM is gone.

mandre · 2019-08-19T06:29:45Z

@Fedosin Please take a look at Fedosin#4 for some fixes to the install doc.

mandre · 2019-08-19T06:33:50Z

/retitle openstack: Update User Documentation

iamemilio · 2019-08-19T14:47:08Z

@abhinavdahiya updated, pls approve

Fedosin · 2019-08-19T14:59:18Z

/hold

Refresh the user documentation with the current state of deployment on OpenStack. Co-Authored-By: Emilio Garcia <[email protected]> Co-Authored-By: Ramon Acedo Rodriguez <[email protected]> Co-Authored-By: Martin André <[email protected]>

Fedosin · 2019-08-19T15:24:48Z

/hold cancel

iamemilio · 2019-08-19T17:30:39Z

/lgtm

Fedosin · 2019-08-19T18:20:31Z

/lgtm

openshift-ci-robot · 2019-08-19T18:20:32Z

@Fedosin: you cannot LGTM your own PR.

Details

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

abhinavdahiya · 2019-08-19T18:28:25Z

/approve

openshift-ci-robot · 2019-08-19T18:28:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abhinavdahiya, Fedosin, iamemilio

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [abhinavdahiya]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 14, 2019

openshift-ci-robot requested review from jhixson74 and patrickdillon August 14, 2019 15:01

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 14, 2019

abhinavdahiya reviewed Aug 14, 2019

View reviewed changes

openshift-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 14, 2019

openshift-ci-robot added the platform/openstack label Aug 15, 2019

abhinavdahiya reviewed Aug 16, 2019

View reviewed changes

mandre suggested changes Aug 18, 2019

View reviewed changes

openshift-ci-robot changed the title ~~Update User Documetation~~ openstack: Update User Documentation Aug 19, 2019

openshift-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 19, 2019

mandre force-pushed the user_docs branch from ffc216e to 83266b3 Compare August 19, 2019 14:40

openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 19, 2019

mandre force-pushed the user_docs branch from 83266b3 to 21abf27 Compare August 19, 2019 14:41

openstack: Update User Documentation

fbf793b

Refresh the user documentation with the current state of deployment on OpenStack. Co-Authored-By: Emilio Garcia <[email protected]> Co-Authored-By: Ramon Acedo Rodriguez <[email protected]> Co-Authored-By: Martin André <[email protected]>

Fedosin force-pushed the user_docs branch from 21abf27 to fbf793b Compare August 19, 2019 15:24

openshift-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 19, 2019

openshift-ci-robot assigned iamemilio Aug 19, 2019

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2019

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2019

openshift-merge-robot merged commit 76540bf into openshift:master Aug 19, 2019

mandre mentioned this pull request Aug 20, 2019

OpenStack: API service VM is not launched/created #2208

Closed

Fedosin deleted the user_docs branch November 1, 2019 11:18


		## Destroying The Cluster

		Destroying the cluster has been noticed to sometimes fail. We are working on patching this, but in a mean time the workaround is to simply run it again. To do so, point it to your cluster with this command:

openstack: Update User Documentation #2218

openstack: Update User Documentation #2218

Uh oh!

Conversation

Fedosin commented Aug 14, 2019

Uh oh!

wking commented Aug 14, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhinavdahiya commented Aug 14, 2019

Uh oh!

iamemilio commented Aug 15, 2019

Uh oh!

iamemilio commented Aug 15, 2019

Uh oh!

iamemilio commented Aug 16, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iamemilio Aug 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mandre commented Aug 19, 2019

Uh oh!

mandre commented Aug 19, 2019

Uh oh!

iamemilio Aug 16, 2019 •

edited

Loading