Skip to content

Comments

Documentation improvements#284

Merged
lebauce merged 1 commit intoredhat-openstack:masterfrom
jprovaznik:params
Oct 19, 2016
Merged

Documentation improvements#284
lebauce merged 1 commit intoredhat-openstack:masterfrom
jprovaznik:params

Conversation

@jprovaznik
Copy link
Contributor

Improved descriptions of some parameters, "parameters" section
is referenced from README as a "complete list of configurable parameters".

README.adoc Outdated

Assuming your external network is called ``public``, your SSH key is ``default`` and your CentOS 7.2 image is ``centos72`` and your domain name is ``example.com``, this is how you deploy OpenShift Origin:
You can pass all environment variables to heat on command line. However,
two example environment files have been given.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

two environment files are provided as examples

README.adoc Outdated
for deployment.

Here is a sample of environment file which uses a subset of parameters which
can be set by user to configure OpenShift deployment. All configurable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by the user

README.adoc Outdated

Here is a sample of environment file which uses a subset of parameters which
can be set by user to configure OpenShift deployment. All configurable
parameters including description can be found in `parameters` section in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the parameters section

README.adoc Outdated
can be set by user to configure OpenShift deployment. All configurable
parameters including description can be found in `parameters` section in
the link:openshift.yaml[main template]. Assuming your external
network is called ``public``, your SSH key is ``default`` and your
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default, your

openshift.yaml Outdated
skip_dns:
type: boolean
description: >
If set to true DNS server is set not on bastion node for resolving
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is not set

Improved descriptions of some parameters, "parameters" section
is referenced from README as a "complete list of configurable parameters".
@jprovaznik
Copy link
Contributor Author

fixed, thanks

@lebauce lebauce merged commit 40a35ce into redhat-openstack:master Oct 19, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants