diff --git a/_build_cfg.yml b/_build_cfg.yml index b52a06bb20a7..b53763d91ec2 100644 --- a/_build_cfg.yml +++ b/_build_cfg.yml @@ -17,9 +17,24 @@ Name: OpenShift Documentation Dir: welcome Topics: - - Name: Overview + - Name: Welcome File: index +--- +Name: Getting Started +Dir: getting_started +Topics: + - Name: Overview + File: overview + - Name: Interacting with OpenShift + File: interfaces + - Name: Preliminary Steps + File: preliminary_steps + - Name: Creating an Application + File: create_app + - Name: Deploying an Application + File: deploy_app + --- Name: Installing Client Tools Dir: client_tools_install_guide diff --git a/getting_started/create_app.adoc b/getting_started/create_app.adoc new file mode 100644 index 000000000000..f2a4a5cfca91 --- /dev/null +++ b/getting_started/create_app.adoc @@ -0,0 +1,85 @@ += Create an Application +{product-author} +{product-version} +:data-uri: +:icons: +:experimental: + +When you have completed the link:preliminary_steps.html[preliminary steps] and configured the client tools with the interactive wizard, you are ready to create an application. You should already have a domain created under which you will create the new application. + +You can create a new application with either the management console or the command line interface, referred to as the client tools. + +== Management Console +. Log into your account from the management console. +. From the btn:[Applications] tab, click btn:[Add Application]. +. Click on the web framework cartridge you want to create. +. Enter the name for your application, select whether to make it scalable, and choose the number of gears. +. Click btn:[Create Application]. + +After the application is created, you can view it with the public URL in the form _-.rhcloud.com_. + +When you create an application with the management console, the application's source code repository is not automatically copied to your workstation. Therefore, you must manually copy it so that you can modify the code and deploy the application to suit your requirements. + +From the directory where you want to clone the application's source code repository to, run the following command: + +---- +$ git clone +---- + +//If you did not create a domain during the link:../client_tools_install_guide/configuring_client_tools.html[initial configuration] of the client tools, you must create one before you can create an application. + +//Create a domain with the following command: + +//---- +//$ rhc domain create +//---- + +== Client Tools (CLI) +From the directory where you want the application created, run the following command: + +---- +$ rhc app create +---- + +If multiple versions of the application are supported, you must specify the version of the cartridge: + +---- +$ rhc app create +---- + +In the following example, because multiple versions of Python are supported we have specified the most current version. + +.Creating a Python Application +==== + +---- +$ rhc app create mypython python-3.3 +Application Options +------------------- +Domain: mydomain +Cartridges: python-3.3 +Gear Size: default +Scaling: no + +Creating application 'mypython' ... done + + +Waiting for your DNS name to be available ... done + +Cloning into 'mypython'... +Warning: Permanently added 'mypython-mydomain.rhcloud.com' (RSA) to the list of known hosts. + +Your application 'mypython' is now available. + + URL: http://mypython-mydomain.rhcloud.com/ + SSH to: 54052e482587c84787000ad7@mypython-mydomain.rhcloud.com + Git remote: ssh://54052e482587c84787000ad7@mypython-mydomain.rhcloud.com/~/git/mypython.git/ + Cloned to: /home/User/mypython + +Run 'rhc show-app mypython' for more details about your app. +---- +==== + +When you create a new application with the client tools, a copy of the application's source code repository is automatically downloaded to the directory on your workstation where you created the application. + +After the application is created, you can view it with the public URL in the form _-.example.com_. For the application we created in the example the public URL is mypython-mydomain.rhcloud.com. \ No newline at end of file diff --git a/getting_started/deploy_app.adoc b/getting_started/deploy_app.adoc new file mode 100644 index 000000000000..ec94cde23afe --- /dev/null +++ b/getting_started/deploy_app.adoc @@ -0,0 +1,27 @@ += Deploy an Application +{product-author} +{product-version} +:data-uri: +:icons: +:experimental: + +With the application link:create_app.html[created and the Git repository cloned] to your workstation, you can make code changes to your application locally and deploy the application to the remote server with Git. The basic Git work flow for making changes and deploying your application is: + +* Make the necessary changes to your application +* Add and commit those changes on your workstation +* Push those changes to the remote server + +After making the changes to your application code, add and commit those changes on your workstation: + +---- +$ git add . +$ git commit -am "Commit my changes so that I can push them to the remote server" +---- + +Push the code changes to the remote server with: + +---- +$ git push +---- + +Your code changes are then copied to the remote server, and you can view the changes by visiting the public URL of the application. \ No newline at end of file diff --git a/getting_started/images/2427.png b/getting_started/images/2427.png new file mode 100644 index 000000000000..6addb98cc7fe Binary files /dev/null and b/getting_started/images/2427.png differ diff --git a/getting_started/images/2428.png b/getting_started/images/2428.png new file mode 100644 index 000000000000..9b5282c9992f Binary files /dev/null and b/getting_started/images/2428.png differ diff --git a/getting_started/images/2429.png b/getting_started/images/2429.png new file mode 100644 index 000000000000..1a3de04a18ee Binary files /dev/null and b/getting_started/images/2429.png differ diff --git a/getting_started/images/2430.png b/getting_started/images/2430.png new file mode 100644 index 000000000000..6e35e3bf027e Binary files /dev/null and b/getting_started/images/2430.png differ diff --git a/getting_started/images/4244.png b/getting_started/images/4244.png new file mode 100644 index 000000000000..c914b5453b89 Binary files /dev/null and b/getting_started/images/4244.png differ diff --git a/getting_started/interfaces.adoc b/getting_started/interfaces.adoc new file mode 100644 index 000000000000..f25150f01dd1 --- /dev/null +++ b/getting_started/interfaces.adoc @@ -0,0 +1,50 @@ += Introduction +{product-author} +{product-version} +:data-uri: +:icons: + +There are two interfaces available for interacting with OpenShift Online: the Management Console graphical user interface and the command line interface (CLI), referred to as the client tools. + +== Management Console +The OpenShift Management Console is a https://openshift.redhat.com/app/login?then=%2Fapp%2Fconsole[web interface] that you can access with a web browser, and is best suited for: + +* Setting up, administering and managing accounts +* Launching new applications +* Managing and monitoring applications + +The following screenshot shows the home page of the Management Console when you first log into your account. Each tab across the top navigation bar provides further functionality to help you manage your account, applications, and more. + +.Management Console +image:4244.png[] + +The following table provides a brief description of the different pages and settings available in the Management Console. + +[cols=".^1,.^2,7",options="header"] +|=== +| |Page |Description + +|image:2427.png[] +|Applications +|View and manage applications and cartridges. If there are no applications, you can create new applications from this page. + +|image:2428.png[] +|Settings +|View and manage SSH keys, domains, and account authorizations. + +|image:2429.png[] +|Help +|Access to KBase articles, community forums, tutorials, and other community resources. A wide variety of resources are available for diagnosing and resolving issues with your account or your applications. + +|image:2430.png[] +|My Account +|View and manage account information, including account upgrades. This page shows account details, subscription plan, and account usage. Red Hat technical support is available from here depending on the plan subscription. +|=== + +== Client Tools +The client tools provide a command line interface for advanced features that you can use to code, debug, and manage your applications. Installing and configuring the client tools will: + +* Create an SSH key pair on your workstation and upload the public key to the remote server. +* Configure your workstation to authenticate and communicate with the remote server. +* Create an authorization token on your workstation so that you do not have enter your login credentials with each command. + diff --git a/getting_started/overview.adoc b/getting_started/overview.adoc new file mode 100644 index 000000000000..65e4946381ad --- /dev/null +++ b/getting_started/overview.adoc @@ -0,0 +1,8 @@ += Overview +{product-author} +{product-version} +:data-uri: +:icons: +:experimental: + +Welcome to OpenShift! These topics will help you get started with OpenShift and contain all the steps necessary so that you can begin creating your first application. \ No newline at end of file diff --git a/getting_started/preliminary_steps.adoc b/getting_started/preliminary_steps.adoc new file mode 100644 index 000000000000..0964687ed37a --- /dev/null +++ b/getting_started/preliminary_steps.adoc @@ -0,0 +1,22 @@ += Preliminary Steps +{product-author} +{product-version} +:data-uri: +:icons: + +You must complete the following preliminary steps to get started with OpenShift. + +*Step 1*: https://www.openshift.com/app/account/new?then=/community/get-started[Sign up for an account] + +*Step 2*: link:../client_tools_install_guide/overview.html[Install the client tools] + +*Step 3*: link:../client_tools_install_guide/configuring_client_tools.html[Configure the client tools] + +Note that you can start the interactive setup wizard with the `rhc setup` command at any time to configure the client tools. + +//[cols="2,7"] +//|=== +//|Step 1 |https://www.openshift.com/app/account/new?then=/community/get-started[Sign up for an account] +//|Step 2 |link:../client_tools_install_guide/configuring_client_tools.html[Install and configure the client tools] +//|Step 3 |Create, deploy, and view your application +//|=== \ No newline at end of file diff --git a/welcome/index.adoc b/welcome/index.adoc index 013530a47aab..cb672c48b834 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -4,14 +4,29 @@ :data-uri: :icons: -Welcome to the OpenShift documentation site! +Welcome to OpenShift documentation. Here you will find information and resources to help you learn about OpenShift and its features. From getting started with creating your first application to using the advanced features, these resources provide information to set up and manage your OpenShift environment. -== Getting Started -New to OpenShift? No problem. Check out: -* link:#[Topic 1] -* link:#[Topic 2] -* link:#[Topic 3] +[cols="2",frame="none",grid="cols"] +|=== + + +a|link:../getting_started/overview.html[*Getting Started*] + +Describes the initial steps required to begin using OpenShift and create your first application. + +a|link:../client_tools_install_guide/overview.html[*Installing client Tools*] + +These topics describe how to install and configure the OpenShift command line interface (CLI) client tools on various operating systems and prepare your workstation to communicate with the remote server. + +a|link:../user_guide/overview.html[*User Guide*] + +Describes key concepts of OpenShift with instructions on how to use the features to create and manage OpenShift applications. + +a|link:../cartridge_specification_guide/overview.html[*Developing Cartridges*] + +These topics provide reference information and specifications for developing custom cartridges for OpenShift. +|=== ifdef::openshift-origin,openshift-enterprise[] == Deploying and Managing OpenShift