Skip to content

Commit 2c6ff05

Browse files
committed
Migration: Master Dev Guide
1 parent 98bf719 commit 2c6ff05

30 files changed

+279
-276
lines changed

architecture/core_concepts/routes.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,7 @@ A secured route is one that specifies the TLS termination of the route.
365365
The available types of termination are xref:secured-routes[described
366366
below].
367367

368+
[[path-based-routes]]
368369
== Path Based Routes
369370
Path based routes specify a path component that can be compared against
370371
a URL (which requires that the traffic for the route be HTTP based) such

dev_guide/app_tutorials/quickstarts.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ toc::[]
1414

1515
A quickstart is a basic example of an application running on {product-title}.
1616
Quickstarts come in a variety of languages and frameworks, and are defined in a
17-
link:../../dev_guide/templates.html[template], which is constructed from a set
17+
xref:../../dev_guide/templates.adoc#dev-guide-templates[template], which is constructed from a set
1818
of services, build configurations, and deployment configurations. This template
1919
references the necessary images and source repositories to build and deploy the
2020
application.
2121

2222
To explore a quickstart, create an application from a template. Your
2323
administrator may have already installed these templates in your {product-title}
2424
cluster, in which case you can simply select it from the web console. See the
25-
link:../../dev_guide/templates.html[template] documentation for more information
25+
xref:../../dev_guide/templates.adoc#dev-guide-templates[template] documentation for more information
2626
on how to upload, create from, and modify a template.
2727

2828
Quickstarts refer to a source repository that contains the application source

dev_guide/app_tutorials/ruby_on_rails.adoc

+22-22
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ First make sure that an instance of {product-title} is running and is available.
3737
ifdef::openshift-enterprise,openshift-origin[]
3838
For
3939
more info on how to get {product-title} up and running check the
40-
link:../../install_config/install/index.html[installation methods].
40+
xref:../../install_config/install/index.adoc#install-config-install-index[installation methods].
4141
endif::[]
42-
Also make sure that your link:../../cli_reference/get_started_cli.html[`oc` CLI
42+
Also make sure that your xref:../../cli_reference/get_started_cli.adoc#cli-reference-get-started-cli[`oc` CLI
4343
client is installed] and the command is accessible from your command shell, so
4444
you can use it to
45-
link:../../cli_reference/get_started_cli.html#basic-setup-and-login[log in]
45+
xref:../../cli_reference/get_started_cli.adoc#basic-setup-and-login[log in]
4646
using your email address and password.
4747

4848
=== Setting Up the Database
@@ -167,7 +167,7 @@ If you don't see the page, check the logs that are output to your server to debu
167167

168168
=== Configuring the Application for {product-title}
169169

170-
In order to have your application communicating with the PostgreSQL database service that will be running in {product-title}, you will need to edit the `default` section in your `config/database.yml` to use link:../../using_images/db_images/postgresql.html#environment-variables[environment variables], which you will define later, upon the database service creation.
170+
In order to have your application communicating with the PostgreSQL database service that will be running in {product-title}, you will need to edit the `default` section in your `config/database.yml` to use xref:../../using_images/db_images/postgresql.adoc#postgresql-environment-variables[environment variables], which you will define later, upon the database service creation.
171171

172172
The `default` section in your edited `config/database.yml` together with pre-defined variables should look like:
173173

@@ -180,7 +180,7 @@ default: &default
180180
adapter: postgresql
181181
encoding: unicode
182182
# For details on connection pooling, see rails configuration guide
183-
# http://guides.rubyonrails.org/configuring.html#database-pooling
183+
# http://guides.rubyonrails.org/configuring.adoc#database-pooling
184184
pool: <%= ENV["POSTGRESQL_MAX_CONNECTIONS"] || 5 %>
185185
username: <%= user %>
186186
password: <%= password %>
@@ -242,26 +242,26 @@ $ git push
242242

243243
== Deploying Your Application to {product-title}
244244

245-
To deploy your Ruby on Rails application, create a new link:../projects.html[Project] for the application:
245+
To deploy your Ruby on Rails application, create a new xref:../projects.adoc#dev-guide-projects[Project] for the application:
246246

247247
----
248248
$ oc new-project rails-app --description="My Rails application" --display-name="Rails Application"
249249
----
250250

251-
After creating the the `rails-app` link:../projects.html[project], you will be automatically switched to the new project namespace.
251+
After creating the the `rails-app` xref:../projects.adoc#dev-guide-projects[project], you will be automatically switched to the new project namespace.
252252

253253
Deploying your application in {product-title} involves three steps:
254254

255-
* Creating a database link:../../architecture/core_concepts/pods_and_services.html#services[service] from {product-title}'s link:../../using_images/db_images/postgresql.html[PostgreSQL image]
256-
* Creating a frontend link:../../architecture/core_concepts/pods_and_services.html#services[service] from {product-title}'s link:../../using_images/s2i_images/ruby.html[Ruby 2.0 builder image] and your Ruby on Rails source code, which we wire with the database service
255+
* Creating a database xref:../../architecture/core_concepts/pods_and_services.adoc#services[service] from {product-title}'s xref:../../using_images/db_images/postgresql.adoc#using-images-db-images-postgresql[PostgreSQL image]
256+
* Creating a frontend xref:../../architecture/core_concepts/pods_and_services.adoc#services[service] from {product-title}'s xref:../../using_images/s2i_images/ruby.adoc#using-images-s2i-images-ruby[Ruby 2.0 builder image] and your Ruby on Rails source code, which we wire with the database service
257257
* Creating a route for your application.
258258

259259
[[creating-the-database-service]]
260260
=== Creating the Database Service
261261

262-
Your Rails application expects a running database link:../../architecture/core_concepts/pods_and_services.html#services[service]. For this service use link:http://www.postgresql.org/[PostgeSQL] database link:../../using_images/db_images/postgresql.html[image].
262+
Your Rails application expects a running database xref:../../architecture/core_concepts/pods_and_services.adoc#services[service]. For this service use link:http://www.postgresql.org/[PostgeSQL] database xref:../../using_images/db_images/postgresql.adoc#using-images-db-images-postgresql[image].
263263

264-
To create the database link:../../architecture/core_concepts/pods_and_services.html#services[service] you will use the link:../new_app.html[oc new-app] command. To this command you will need to pass some necessary link:../../using_images/db_images/postgresql.html#environment-variables[environment variables] which will be used inside the database container. These link:../../using_images/db_images/postgresql.html#environment-variables[environment variables] are required to set the username, password, and name of the database. You can change the values of these link:../../using_images/db_images/postgresql.html#environment-variables[environment variables] to anything you would like. The variables we are going to be setting are as follows:
264+
To create the database xref:../../architecture/core_concepts/pods_and_services.adoc#services[service] you will use the xref:../new_app.adoc#dev-guide-new-app[oc new-app] command. To this command you will need to pass some necessary xref:../../using_images/db_images/postgresql.adoc#environment-variables[environment variables] which will be used inside the database container. These xref:../../using_images/db_images/postgresql.adoc#environment-variables[environment variables] are required to set the username, password, and name of the database. You can change the values of these xref:../../using_images/db_images/postgresql.adoc#environment-variables[environment variables] to anything you would like. The variables we are going to be setting are as follows:
265265

266266
* POSTGRESQL_DATABASE
267267
* POSTGRESQL_USER
@@ -293,15 +293,15 @@ $ oc get pods --watch
293293

294294
=== Creating the Frontend Service
295295

296-
To bring your application to {product-title}, you need to specify a repository in which your application lives, using once again the link:../new_app.html[oc new-app] command, in which you will need to specify database related link:../../using_images/db_images/postgresql.html#environment-variables[environment variables] we setup in the link:./ruby_on_rails.html#creating-the-database-service[Creating the Database Service]:
296+
To bring your application to {product-title}, you need to specify a repository in which your application lives, using once again the xref:../new_app.adoc#dev-guide-new-app[oc new-app] command, in which you will need to specify database related xref:../../using_images/db_images/postgresql.adoc#environment-variables[environment variables] we setup in the xref:./ruby_on_rails.adoc#creating-the-database-service[Creating the Database Service]:
297297

298298
----
299299
$ oc new-app path/to/source/code --name=rails-app -e POSTGRESQL_USER=username -e POSTGRESQL_PASSWORD=password -e POSTGRESQL_DATABASE=db_name
300300
----
301301

302-
With this command, {product-title} fetches the source code, sets up the Builder image, link:../builds.html[builds] your application image, and deploys the newly created image together with the specified link:../../using_images/db_images/postgresql.html#environment-variables[environment variables]. The application is named `rails-app`.
302+
With this command, {product-title} fetches the source code, sets up the Builder image, xref:../builds.adoc#dev-guide-builds[builds] your application image, and deploys the newly created image together with the specified xref:../../using_images/db_images/postgresql.adoc#environment-variables[environment variables]. The application is named `rails-app`.
303303

304-
You can verify the environment variables have been added by viewing the JSON document of the `rails-app` link:../deployments.html[DeploymentConfig]:
304+
You can verify the environment variables have been added by viewing the JSON document of the `rails-app` xref:../deployments.adoc#dev-guide-deployments[DeploymentConfig]:
305305

306306
----
307307
$ oc get dc rails-app -o json
@@ -326,13 +326,13 @@ env": [
326326
],
327327
----
328328

329-
To check the link:../builds.html[build] process, use the link:../builds.html#accessing-build-logs[build-logs] command:
329+
To check the xref:../builds.adoc#dev-guide-builds[build] process, use the xref:../builds.adoc#accessing-build-logs[build-logs] command:
330330

331331
----
332332
$ oc logs -f build rails-app-1
333333
----
334334

335-
Once the link:../builds.html[build] is complete, you can look at the running link:../../architecture/core_concepts/pods_and_services.html#pods[pods] in {product-title}
335+
Once the xref:../builds.adoc#dev-guide-builds[build] is complete, you can look at the running xref:../../architecture/core_concepts/pods_and_services.adoc#pods[pods] in {product-title}
336336

337337
----
338338
$ oc get pods
@@ -344,7 +344,7 @@ Before your application will be functional, you need to initialize the database
344344

345345
* Manually from the running frontend container:
346346

347-
First you need to exec into frontend container with link:../../cli_reference/basic_cli_operations.html#troubleshooting-and-debugging-cli-operations[rsh] command:
347+
First you need to exec into frontend container with xref:../../cli_reference/basic_cli_operations.adoc#troubleshooting-and-debugging-cli-operations[rsh] command:
348348

349349
$ oc rsh <FRONTEND_POD_ID>
350350

@@ -354,11 +354,11 @@ Run the migration from inside the container:
354354

355355
If you are running your Rails application in a `development` or `test` environment you don't have to specify the `RAILS_ENV` environment variable.
356356

357-
* By adding pre-deployment link:../../dev_guide/deployments.html#lifecycle-hooks[lifecycle hooks] in your template. For example check the link:https://github.com/openshift/rails-ex/blob/master/openshift/templates/rails-postgresql.json#L122-L130[hooks example] in our link:https://github.com/openshift/rails-ex[Rails example] application.
357+
* By adding pre-deployment xref:../../dev_guide/deployments.adoc#lifecycle-hooks[lifecycle hooks] in your template. For example check the link:https://github.com/openshift/rails-ex/blob/master/openshift/templates/rails-postgresql.json#L122-L130[hooks example] in our link:https://github.com/openshift/rails-ex[Rails example] application.
358358

359359
=== Creating a Route for Your Application
360360

361-
To expose a service by giving it an externally-reachable hostname like `www.example.com` use {product-title} link:../routes.html[route]. In your case you need to expose the frontend service by typing:
361+
To expose a service by giving it an externally-reachable hostname like `www.example.com` use {product-title} xref:../routes.adoc#dev-guide-routes[route]. In your case you need to expose the frontend service by typing:
362362

363363
----
364364
$ oc expose service rails-app --hostname=www.example.com
@@ -368,11 +368,11 @@ $ oc expose service rails-app --hostname=www.example.com
368368
====
369369
It's the user's responsibility to ensure the hostname they specify resolves into the IP address of the router. For more information, check the {product-title} documentation on:
370370
====
371-
* link:../../architecture/core_concepts/routes.html#routers[Routes]
371+
* xref:../../architecture/core_concepts/routes.adoc#routers[Routes]
372372
ifdef::openshift-enterprise,openshift-origin[]
373-
* link:../../admin_guide/high_availability.html#configuring-a-highly-available-routing-service[Configuring a Highly-available Routing Service]
373+
* xref:../../admin_guide/high_availability.adoc#configuring-a-highly-available-routing-service[Configuring a Highly-available Routing Service]
374374
endif::[]
375375
ifdef::openshift-dedicated[]
376-
* https://docs.openshift.com/enterprise/latest/admin_guide/high_availability.html#configuring-a-highly-available-routing-service[Configuring
376+
* https://docs.openshift.com/enterprise/latest/admin_guide/high_availability.adoc#configuring-a-highly-available-routing-service[Configuring
377377
a Highly-available Routing Service] (OpenShift Enterprise documentation)
378378
endif::[]

dev_guide/application_lifecycle.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ administrator within your organization.
3939
Develop::
4040
* Using your editor/IDE of choice, create a basic skeleton of an application. It
4141
should be developed enough to tell {product-title}
42-
link:../dev_guide/new_app.html#language-detection[what kind of application it
42+
xref:../dev_guide/new_app.adoc#language-detection[what kind of application it
4343
is].
4444
* Push the code to your Git repository.
4545

4646
Generate::
47-
* link:../dev_guide/new_app.html[Create a basic application] using the `new-app`
47+
* xref:../dev_guide/new_app.adoc#dev-guide-new-app[Create a basic application] using the `new-app`
4848
command. {product-title} generates build and deployment configurations.
4949

5050
Manage::
@@ -53,7 +53,7 @@ Manage::
5353
* Continue to locally develop and polish your code.
5454
* Push your code to a Git repository.
5555
* Is any extra configuration needed? Explore the
56-
link:../dev_guide/index.html[Developer Guide] for more options.
56+
xref:../dev_guide/index.adoc#dev-guide-index[Developer Guide] for more options.
5757

5858
Verify::
5959
* You can verify your application in a number of ways. You can push your changes
@@ -85,7 +85,7 @@ Access to {product-title}::
8585
administrator within your organization.
8686

8787
Generate::
88-
* link:../dev_guide/new_app.html[Create a basic application] using the `new-app`
88+
* xref:../dev_guide/new_app.adoc#dev-guide-new-app[Create a basic application] using the `new-app`
8989
command. {product-title} generates build and deployment configurations.
9090

9191
Verify::
@@ -96,4 +96,4 @@ Manage::
9696
* Continue to develop your application code until you are happy with the results.
9797
* Rebuild your application in {product-title} to accept any newly pushed code.
9898
* Is any extra configuration needed? Explore the
99-
link:../dev_guide/index.html[Developer Guide] for more options.
99+
xref:../dev_guide/index.adoc#dev-guide-index[Developer Guide] for more options.

dev_guide/authentication.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ toc::[]
1414

1515
== Web Console Authentication
1616
When accessing the
17-
link:../architecture/infrastructure_components/web_console.html[web console]
17+
xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web console]
1818
ifdef::openshift-origin,openshift-online,openshift-dedicated,openshift-origin[]
1919
from a browser at *<master_public_addr>:8443*, you are automatically redirected
2020
endif::[]
@@ -29,18 +29,18 @@ image::login_page.png["Web Console Login Page"]
2929
endif::[]
3030

3131
Review the
32-
link:../architecture/infrastructure_components/web_console.html[browser versions
32+
xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[browser versions
3333
and operating systems] that can be used to access the web console.
3434

3535
You can provide your login credentials on this page to obtain a token to make
3636
API calls. After logging in, you can navigate your projects using the
37-
link:../architecture/infrastructure_components/web_console.html[web console].
37+
xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web console].
3838

3939
[[cli-authentication]]
4040

4141
== CLI Authentication
4242
You can authenticate from the command line using the CLI command `oc login`.
43-
You can link:../cli_reference/get_started_cli.html[get started with the CLI] by
43+
You can xref:../cli_reference/get_started_cli.adoc#cli-reference-get-started-cli[get started with the CLI] by
4444
running this command without any options:
4545

4646
----
@@ -51,7 +51,7 @@ The command's interactive flow helps you establish a session to an {product-titl
5151
server with the provided credentials. If any information required to successfully
5252
log in to an {product-title} server is not provided, the command prompts for user
5353
input as required. The
54-
link:../cli_reference/get_started_cli.html#cli-configuration-files[configuration]
54+
xref:../cli_reference/get_started_cli.adoc#cli-configuration-files[configuration]
5555
is automatically saved and is then used for every subsequent command.
5656

5757
All configuration options for the `oc login` command, listed in the `oc login
@@ -123,17 +123,17 @@ for user input to confirm (`y/N` kind of input) about connecting insecurely.
123123
|===
124124
125125
CLI configuration files allow you to easily
126-
link:../cli_reference/manage_cli_profiles.html[manage multiple CLI profiles].
126+
xref:../cli_reference/manage_cli_profiles.adoc#cli-reference-manage-cli-profiles[manage multiple CLI profiles].
127127
128128
// tag::systemadminlogin[]
129129
130130
[NOTE]
131131
====
132132
If you have access to administrator credentials but are no longer logged in as
133-
the link:../architecture/core_concepts/projects_and_users.html#users[default
133+
the xref:../architecture/core_concepts/projects_and_users.adoc#users[default
134134
system user] *system:admin*, you can log back in as this user at any time as
135135
long as the credentials are still present in your
136-
link:../cli_reference/get_started_cli.html#cli-configuration-files[CLI
136+
xref:../cli_reference/get_started_cli.adoc#cli-configuration-files[CLI
137137
configuration file]. The following command logs in and switches to the *default*
138138
project:
139139

0 commit comments

Comments
 (0)