diff --git a/_build_cfg.yml b/_build_cfg.yml index b52a06bb20a7..70c76b331c05 100644 --- a/_build_cfg.yml +++ b/_build_cfg.yml @@ -17,13 +17,30 @@ 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 Topics: + - Name: Overview + File: overview - Name: On Fedora File: installing_client_tools_on_fedora - Name: On OS X @@ -60,6 +77,8 @@ Topics: Name: Developing Cartridges Dir: cartridge_specification_guide Topics: + - Name: Overview + File: overview - Name: Managed Files File: managed_files - Name: Locking Cartridges diff --git a/cartridge_specification_guide/managed_files.adoc b/cartridge_specification_guide/managed_files.adoc index 720033c6896d..46fe8b1263cf 100644 --- a/cartridge_specification_guide/managed_files.adoc +++ b/cartridge_specification_guide/managed_files.adoc @@ -28,35 +28,35 @@ Some entries allow string values. These values return directly without any modif File Pattern | Files that an application developer can read but not update - |link:/cartridge_spec_guide/locking_cartridges[Locking Cartridges] + |link:locking_cartridges.html[Locking Cartridges] | [parameter]#snapshot_exclusions# | File Pattern | Array of file names not to backup from the gear when +rhc snapshot+ runs - |link:/cartridge_spec_guide/backing_up_and_restoring_cartridges[Backing Up and Restoring Cartridges] + |link:backing_up_and_restoring_cartridges.html[Backing Up and Restoring Cartridges] | [parameter]#setup_rewritten# | File Pattern | Files that are removed before running +setup+ - |link:/cartridge_spec_guide/cartridge_scripts[Cartridge Scripts] + |link:cartridge_scripts.html[Cartridge Scripts] | [parameter]#process_templates# | File Pattern | ERB templates that are rendered after running +setup+ - |link:/cartridge_spec_guide/cartridge_scripts#embedded_ruby_processing[Embedded Ruby (ERB) Processing] + |link:cartridge_scripts.html#embedded_ruby_processing[Embedded Ruby (ERB) Processing] | [parameter]#restore_transforms# | Strings | Set of regex transforms for rewriting file names when +rhc restore+ is run. - |link:/cartridge_spec_guide/backing_up_and_restoring_cartridges[Backing Up and Restoring Cartridges] + |link:backing_up_and_restoring_cartridges.html[Backing Up and Restoring Cartridges] |=== The following example demonstrates the structure of a basic [filename]#$managed_files.yml# file: diff --git a/cartridge_specification_guide/openshift_cartridge_reference.adoc b/cartridge_specification_guide/openshift_cartridge_reference.adoc index 65100708998d..69d8aeb6a0b4 100644 --- a/cartridge_specification_guide/openshift_cartridge_reference.adoc +++ b/cartridge_specification_guide/openshift_cartridge_reference.adoc @@ -31,7 +31,7 @@ To support multiple software versions within one cartridge, create symbolic link When creating an instance of your cartridge for use by a gear, OpenShift copies the files, links, and directories from the cartridge library, with the exception of the [filename]#$cartridge_name/usr/# directory. The [filename]#$cartridge_name/usr/# directory is symbolically linked to the gear's cartridge instance. This link enables all cartridge instances to share libraries and other data. -See link:locking_cartridges[Locking Cartridges] for more information on customizing a cartridge instance. +See link:locking_cartridges.html[Locking Cartridges] for more information on customizing a cartridge instance. [[cartridge_metadata_elements]] == Cartridge Metadata Elements @@ -320,7 +320,7 @@ Additional-Control-Actions: [[endpoints]] === Endpoints -See link:exposing_services[Exposing Services]. +See link:exposing_services.html[Exposing Services]. [[example_openshift.conf.erb_file]] == Example openshift.conf.erb File diff --git a/cartridge_specification_guide/overview.adoc b/cartridge_specification_guide/overview.adoc new file mode 100644 index 000000000000..a67e00559fe7 --- /dev/null +++ b/cartridge_specification_guide/overview.adoc @@ -0,0 +1,6 @@ += Overview +{product-version} +:data-uri: +:icons: + +These topics provide guidelines and specifications about components and services that are essential to the design of custom cartridges. This information helps developers to create custom cartridges so that application components that are not currently supported by the available cartridges can be integrated with OpenShift. diff --git a/client_tools_install_guide/configuring_client_tools.adoc b/client_tools_install_guide/configuring_client_tools.adoc index 67d14e33f60e..4233dfcdf483 100644 --- a/client_tools_install_guide/configuring_client_tools.adoc +++ b/client_tools_install_guide/configuring_client_tools.adoc @@ -43,7 +43,7 @@ Password: password *Authorization Tokens* -You are then prompted to generate an authorization token. Answering _++yes++_ will store a token in your home directory to be used on subsequent requests. When it expires, you are prompted for your password again. +You are then prompted to generate an authorization token. Answering [userinput]#yes# stores a token in your home directory to be used on subsequent requests. When it expires, you are prompted for your password again. ---- OpenShift can create and store a token on disk which allows to you to access the server without using your password. The key is stored in your home directory and should be kept secret. You can delete the key at any time by running 'rhc logout'. @@ -53,7 +53,7 @@ Generating an authorization token for this client ... lasts about 1 day *Configuration File* -With your login credentials, the setup wizard creates the *express.conf* configuration file in your home directory. In the following example, the *express.conf* file is created in the *C:\Users\User1\.openshift* directory. +With your login credentials, the setup wizard creates the [filename]#express.conf# configuration file in your home directory. In the following example, the [filename]#express.conf# file is created in the [filename]#C:\Users\User1\.openshift# directory. ---- Saving configuration to C:\Users\User1\.openshift\express.conf ... done @@ -61,14 +61,14 @@ Saving configuration to C:\Users\User1\.openshift\express.conf ... done *SSH Keys* -Next, the setup wizard configures the SSH keys so that your system can authenticate with the remote server. Because this is the initial configuration, it is assumed no existing SSH keys are found on your system. Therefore, the setup wizard generates a new pair of SSH keys, named *id_rsa* and *id_rsa.pub*, and saves them in your home directory. In the following example the SSH keys are generated and saved in the *C:\Users\User1\.ssh* directory. +Next, the setup wizard configures the SSH keys so that your system can authenticate with the remote server. Because this is the initial configuration, it is assumed no existing SSH keys are found on your system. Therefore, the setup wizard generates a new pair of SSH keys, named [filename]#id_rsa# and [filename]#id_rsa.pub#, and saves them in your home directory. In the following example the SSH keys are generated and saved in the [filename]#C:\Users\User1\.ssh# directory. ---- No SSH keys were found. We will generate a pair of keys for you. Created: C:\Users\User1\.ssh\id_rsa.pub ---- -After the new SSH keys are generated, the public key, *id_rsa.pub*, must be uploaded to the OpenShift server to authenticate your system to the remote server. Enter a name to use for your key, or leave it blank to use the default name. In the following example the default name is used. +After the new SSH keys are generated, the public key, [filename]#id_rsa.pub#, must be uploaded to the OpenShift server to authenticate your system to the remote server. Enter a name to use for your key, or leave it blank to use the default name. In the following example the default name is used. ---- Your public ssh key must be uploaded to the OpenShift server to access code. diff --git a/client_tools_install_guide/installing_client_tools_on_fedora.adoc b/client_tools_install_guide/installing_client_tools_on_fedora.adoc index a771d495e235..689229da55a6 100644 --- a/client_tools_install_guide/installing_client_tools_on_fedora.adoc +++ b/client_tools_install_guide/installing_client_tools_on_fedora.adoc @@ -1,4 +1,4 @@ -= Installing Client Tools on Fedora += Install Client Tools on Fedora {product-author} {product-version} :data-uri: @@ -8,7 +8,7 @@ The OpenShift client tools are supported on Fedora 16 or later and require sudoe [NOTE] ==== -The +sudo+ command only works if the particular user is listed in the +sudoers+ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal when the installation process is complete. +The +sudo+ command only works if the particular user is listed in the +sudoers+ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit `sudo` from the commands shown in the examples. Be sure to close the root terminal when the installation process is complete. ==== You can install the client tools on Fedora operating systems by installing the RPM with the YUM package manager, or by installing the gem. @@ -27,7 +27,7 @@ From the terminal, install the client tools and all other required dependencies: $ sudo yum install rubygem-rhc ---- -*Installing with Gem* +*Install with Gem* 1. From the terminal, install Ruby and RubyGems if they are not already installed: + @@ -53,10 +53,10 @@ $ rhc setup --autocomplete You may have to close your current terminal session, and open a new session to automatically source the bash completion script. -If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the *_.bashrc_* file in your home directory. Do this by adding the following line to to your *_.bashrc_* file: +If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the [flename]#.bashrc# file in your home directory. Do this by adding the following line to to your [flename]#.bashrc# file: ---- source /etc/bash_completion.d/rhc ---- -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/installing_client_tools_on_macosx.adoc b/client_tools_install_guide/installing_client_tools_on_macosx.adoc index 86cb26e9ce13..264bb7406190 100644 --- a/client_tools_install_guide/installing_client_tools_on_macosx.adoc +++ b/client_tools_install_guide/installing_client_tools_on_macosx.adoc @@ -54,4 +54,4 @@ When Ruby and Git have been successfully installed, run the following command to $ sudo gem install rhc ---- -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/installing_client_tools_on_opensuse.adoc b/client_tools_install_guide/installing_client_tools_on_opensuse.adoc index df4f550979b0..47f9c27b5ff6 100644 --- a/client_tools_install_guide/installing_client_tools_on_opensuse.adoc +++ b/client_tools_install_guide/installing_client_tools_on_opensuse.adoc @@ -65,4 +65,4 @@ When the required software has been successfully installed, run the following co $ sudo gem install rhc ---- -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/installing_client_tools_on_rhel.adoc b/client_tools_install_guide/installing_client_tools_on_rhel.adoc index 1e55dc1d9111..61060640c3e5 100644 --- a/client_tools_install_guide/installing_client_tools_on_rhel.adoc +++ b/client_tools_install_guide/installing_client_tools_on_rhel.adoc @@ -1,4 +1,4 @@ -= Installing Client Tools on Red Hat Enterprise Linux += Install Client Tools on Red Hat Enterprise Linux {product-author} {product-version} :data-uri: @@ -12,10 +12,10 @@ You must have the following to successfully install the client tools: [NOTE] ==== -The +sudo+ command only works if the particular user is listed in the *_sudoers_* file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal after the installation completes. +The +sudo+ command only works if the particular user is listed in the *_sudoers_* file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit `sudo` from the commands shown in the examples. Be sure to close the root terminal after the installation completes. ==== -== Installing RubyGems +== Install RubyGems If the RubyGems package is not already installed, you must enable the Red Hat Enterprise Linux optional repository channel. The RubyGems package dependencies are then automatically resolved when the client tools are installed. @@ -31,7 +31,7 @@ If you are using the classic RHN subscription, use the following command to enab $ sudo rhn-channel --add --channel=[architecture]-[operating_system]-optional-6 ---- -* _++architecture++_: your system architecture. Enter either _i386_ or *x86_64* +* _++architecture++_: your system architecture. Enter either _i386_ or _x86_64_ * _++operating system++_: type of operating system installed. Enter either _workstation_ or _server_. For example, if you have Red Hat Enterprise Linux Workstation 6 or later installed on a 64-bit x86 computer, and you are using the classic Red Hat Network subscription, run the following command to enable the optional repository: @@ -40,7 +40,7 @@ For example, if you have Red Hat Enterprise Linux Workstation 6 or later install $ sudo rhn-channel --add --channel=rhel-x86_64-workstation-optional-6 ---- -== Installing Client Tools +== Install Client Tools Ensure that the RubyGems software package is installed on your system. Otherwise, the optional repository channel must be enabled on systems that are registered on RHN. @@ -82,10 +82,10 @@ $ rhc setup --autocomplete You may have to close your current terminal session, and open a new session to automatically source the bash completion script. -If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the *_.bashrc_* file in your home directory. Do this by adding the following line to to your *_.bashrc_* file: +If the automatic completion feature is not persistent when you open a new terminal session, the automatic completion script for the client tools must be sourced in the [flename]#.bashrc# file in your home directory. Do this by adding the following line to to your [flename]#.bashrc# file: ---- source /etc/bash_completion.d/rhc ---- -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/installing_client_tools_on_ubuntu_debian.adoc b/client_tools_install_guide/installing_client_tools_on_ubuntu_debian.adoc index eb7deb9879c5..9e05e66f9170 100644 --- a/client_tools_install_guide/installing_client_tools_on_ubuntu_debian.adoc +++ b/client_tools_install_guide/installing_client_tools_on_ubuntu_debian.adoc @@ -1,10 +1,10 @@ -= Installing Client Tools on Ubuntu and Debian += Install Client Tools on Ubuntu and Debian {product-author} {product-version} :data-uri: :icons: -Installing the client tools on Ubuntu or Debian requires sudoer or root access and comprises four steps: +Install the client tools on Ubuntu or Debian requires sudoer or root access and comprises four steps: *Step 1*: Install *_Ruby_* @@ -19,7 +19,7 @@ Installing the client tools on Ubuntu or Debian requires sudoer or root access a The +sudo+ command only works if the particular user is listed in the _sudoers_ file. As an alternative to sudo access, you can activate a root terminal with the +su+ command and the root password. If you activate a root terminal, omit +sudo+ from the commands shown in the examples. Be sure to close the root terminal after the installation completes. ==== -== Installing Ruby +== Install Ruby From terminal, run the following command to install Ruby: @@ -34,7 +34,7 @@ $ ruby -e 'puts "Welcome to Ruby"' Welcome to Ruby ---- -== Installing RubyGems +== Install RubyGems Run the following command to install RubyGems: @@ -42,7 +42,7 @@ Run the following command to install RubyGems: $ sudo apt-get install rubygems ---- -== Installing Git +== Install Git Run the following command to install Git version control: @@ -58,7 +58,7 @@ $ git --version This command returns the Git version number that was installed. -== Installing Client Tools +== Install Client Tools When the required software has been successfully installed, run the following command to install the client tools: @@ -68,9 +68,9 @@ $ sudo gem install rhc == Installation Issues and Tips -*Executing Client Tool Commands from Any Directory* +*Execute Client Tool Commands from Any Directory* -On Ubuntu and other Debian based distributions, the client tools by default are stored in the `/var/lib/gems/1.8/bin` directory. Therefore, all client tool commands must be executed from this directory, and you must prepend `./` to each command. +On Ubuntu and other Debian based distributions, the client tools by default are stored in the [filename]#/var/lib/gems/1.8/bin# directory. Therefore, all client tool commands must be executed from this directory, and you must prepend [filename]#./# to each command. However, this behavior can be changed by adding the client tools to the PATH environment variable so that you can run client tool commands from any directory. Run the following command to add the client tools to the PATH environment variable, and make it persistent for an entire terminal session: @@ -80,10 +80,10 @@ $ sudo export PATH=/var/lib/gems/1.8/bin:$PATH Now you can run client tool commands from any directory in the current Terminal session. Note that you must do this each time you close the current Terminal session and start a new one. -For a more permanent solution, add the *export PATH=/var/lib/gems/1.8/bin:$PATH* command to your *_.bashrc_* file. Therefore, each time a new Terminal session is started, the client tools are automatically added to the PATH environment variable. You can then run all client tool commands from any directory in Terminal. +For a more permanent solution, add the `export PATH=/var/lib/gems/1.8/bin:$PATH` command to your [flename]#.bashrc# file. Therefore, each time a new Terminal session is started, the client tools are automatically added to the PATH environment variable. You can then run all client tool commands from any directory in Terminal. -*Making Client Tools Available to All Users* +*Make Client Tools Available to All Users* Initially the OpenShift Online client tools are only available to the user installed them. Run the following command to make the client tools available for all users on an Ubuntu system: @@ -93,4 +93,4 @@ $ sudo ln -s /var/lib/gems/1.8/bin/rhc* /usr/bin/ This creates a symbolic link to the client tools binaries in the default search path, and make the client tools available to all users on that system. -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/installing_client_tools_on_windows.adoc b/client_tools_install_guide/installing_client_tools_on_windows.adoc index e8a4e9f9d0c7..e4d7be7987df 100644 --- a/client_tools_install_guide/installing_client_tools_on_windows.adoc +++ b/client_tools_install_guide/installing_client_tools_on_windows.adoc @@ -3,6 +3,7 @@ {product-version} :data-uri: :icons: +:experimental: The OpenShift Client Tools are supported on the following Windows operating systems: @@ -36,14 +37,14 @@ Before you can install the client tools, you must download and install *_RubyIns //[[img-rubyinstaller]] //image:2830.png[image] -2. Double-click the executable RubyInstaller file downloaded in the previos step to launch the RubyInstaller installation wizard. Accept the _Ruby License Agreement_ and click btn:[OK]. +2. Double-click the executable RubyInstaller file downloaded in the previos step to launch the RubyInstaller installation wizard. Accept the *Ruby License Agreement* and click btn:[OK]. -3. Select the _Add Ruby executables to your PATH_ check box, and click btn:[Install] to begin the installation. +3. Select the *Add Ruby executables to your PATH* check box, and click btn:[Install] to begin the installation. + .Select PATH image:2829.png[image] + -Click *Finish* when the install completes. +Click btn:[Finish] when the install completes. === Install Git Version Control @@ -75,4 +76,4 @@ a. Click btn:[Start], type *cmd* in the *Start Search* text box, and then click $ gem install rhc ---- -//When the installation completes, proceed to <> to configure the client tools using the interactive setup wizard. +When the installation completes, proceed to link:configuring_client_tools.html[configure] the client tools using the interactive setup wizard. diff --git a/client_tools_install_guide/overview.adoc b/client_tools_install_guide/overview.adoc new file mode 100644 index 000000000000..a0782170fcfe --- /dev/null +++ b/client_tools_install_guide/overview.adoc @@ -0,0 +1,8 @@ += Overview +{product-version} +:data-uri: +:icons: + +These topics provide instructions on how to install and configure the client tools on workstations with supported operating systems. The client tools allow developers and administrators to create, build, and deploy applications on OpenShift and provide advance features for managing a cloud environment. + +Select the appropriate operating system for specific instructions on how to install the client tools. \ No newline at end of file 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/user_guide/overview.adoc b/user_guide/overview.adoc index 706aed6b2abd..c20dfe89fbba 100644 --- a/user_guide/overview.adoc +++ b/user_guide/overview.adoc @@ -14,4 +14,4 @@ The information and examples included in these topics will help developers: * Monitor and manage application storage and resources == Before You Begin -It is assumed that you have already link:../client_tools_installation_guide/overview.html[installed and configured] the client tools on your workstation. If not, you must do so before you can create and manage OpenShift applications with the client tools. \ No newline at end of file +It is assumed that you have already link:../client_tools_install_guide/overview.html[installed and configured] the client tools on your workstation. If not, you must do so before you can create and manage OpenShift applications with the client tools. \ 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