Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More spelling 3 #1075

Merged
merged 21 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Install Keycloak
We will install and launch Keycloak server behind Apache.

Login to the host where you will install Keycloak. In this tutorial, we are
installing Keycloak on the same host as OnDemand, which is webdev07.hpc.osc.edu.
installing Keycloak on the same host as OnDemand, which is ``webdev07.hpc.osc.edu``.

.. warning::

Expand All @@ -25,7 +25,7 @@ Initial Installation Steps
sudo tar xzf keycloak-9.0.0.tar.gz


#. Add keycloak user and change ownership of files
#. Add ``keycloak`` user and change ownership of files

.. code-block:: sh

Expand All @@ -38,13 +38,13 @@ Initial Installation Steps

sudo install -d -o keycloak -g keycloak /var/lib/keycloak

This makes a home directory, which is needed when running API calls as keycloak user. Finally we set proper permissions:
This makes a home directory, which is needed when running API calls as ``keycloak`` user. Finally we set proper permissions:

.. code-block:: sh

sudo chown keycloak: -R keycloak-9.0.0

#. Restrict access to keycloak-9.0.0/standalone, which will contain
#. Restrict access to ``keycloak-9.0.0/standalone``, which will contain
sensitive data for the Keycloak server

.. code-block:: sh
Expand All @@ -60,7 +60,7 @@ Initial Installation Steps
sudo yum install java-1.8.0-openjdk-devel


#. Added 'admin' to '/opt/keycloak-9.0.0/standalone/configuration/keycloak-add-user.json', (re)start server to load user.
#. Added 'admin' to ``/opt/keycloak-9.0.0/standalone/configuration/keycloak-add-user.json``, (re)start server to load user.

If you are not already there:

Expand All @@ -87,22 +87,22 @@ Initial Installation Steps
sudo -u keycloak ./bin/jboss-cli.sh 'embed-server,/socket-binding-group=standard-sockets/socket-binding=proxy-https:add(port=443)'
sudo -u keycloak ./bin/jboss-cli.sh 'embed-server,/subsystem=undertow/server=default-server/http-listener=default:write-attribute(name=redirect-socket,value=proxy-https)'

Or you can use a config.cli file that contains these commands. We have
Or you can use a ``config.cli`` file that contains these commands. We have
provided an example file to make use of in this gist, with blocks commented
out so you can wget the file, edit as appropriate, and run via:
out so you can ``wget`` the file, edit as appropriate, and run via:

.. code-block:: sh

sudo -u keycloak ./bin/jboss-cli.sh --file=config.cli

Where the config.cli looks like:
Where the ``config.cli`` looks like:

.. literalinclude:: example-keycloak-jboss-config.cli

Start Keycloak Server
-------------------------

#. Create keycloak.service to start and stop the server:
#. Create ``keycloak.service`` to start and stop the server:

.. code-block:: sh

Expand All @@ -125,7 +125,7 @@ Start Keycloak Server
EOF


Then start keycloak:
Then start ``keycloak``:

.. code-block:: sh

Expand All @@ -148,7 +148,7 @@ Start Keycloak Server
Place Apache in front of Keycloak
---------------------------------

#. Define apache config to proxy keycloak requests
#. Define apache configuration to proxy Keycloak requests.

.. note::

Expand All @@ -164,7 +164,7 @@ Place Apache in front of Keycloak
Add ``/opt/rh/httpd24/root/etc/httpd/conf.d/ood-keycloak.conf``, making changes
for the appropriate SSL certificate locations. Notice we are proxying
``https://ondemand-idpdev.hpc.osc.edu`` to ``http://localhost:8080`` which is the default
port the Keycloak webserver runs as.
port the Keycloak web-server runs as.

.. literalinclude:: example-keycloak-apache.conf

Expand All @@ -185,13 +185,13 @@ Differences if installing Keycloak on separate host
When installing Keycloak on a separate host, the difference between this
tutorial would be:

#. throughout the rest of the tutorial replace ``https://ondemand-idpdev.hpc.osc.edu`` with the keycloak host
#. throughout the rest of the tutorial replace ``https://ondemand-idpdev.hpc.osc.edu`` with the Keycloak host
#. possibly use Apache 2.4 default distribution instead of software collections,
meaning that configuration would be at /etc/httpd/conf.d/ instead of
/opt/rh/httpd24/root/etc/httpd/conf.d/ and starting the
meaning that configuration would be at ``/etc/httpd/conf.d/`` instead of
``/opt/rh/httpd24/root/etc/httpd/conf.d/`` and starting the
service is likely ``sudo systemctl start httpd`` instead of ``sudo systemctl start httpd24-httpd``

For example, if Keycloak were installed on a separate host idp.hpc.edu then the
Apache config might look like:
For example, if Keycloak were installed on a separate host ``idp.hpc.edu`` then the
Apache configuration might look like:

.. literalinclude:: example-keycloak-apache-separate-host.conf
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Enable in OnDemand v1.3:
Here are example steps to enable a user ``efranz``, assuming ``efranz``'s home directory is at ``/home/efranz``:

#. Create ``dev`` directory ``/home/efranz/ondemand/dev`` where ``efranz``'s development apps will go (or ask ``efranz`` to do that).
#. Have ``efranz`` access the Dashboard, and they will see the Develop drop-down. (if this doesn't happen, )
#. Have ``efranz`` access the Dashboard, and they will see the Develop drop-down. (if this does not happen)

.. note::

Expand Down
4 changes: 2 additions & 2 deletions source/reference/files/submit-yml-erb.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _submit-yml-erb:

submit.yml.erb
==============
``submit.yml.erb``
==================

This is the file that is submitted to a batch connect job. It is comprised
of a ``script`` and a ``batch_connect`` attribute. The ``batch_connect``
Expand Down
2 changes: 1 addition & 1 deletion source/reference/files/submit-yml/basic-bc-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ Basic Batch Connect Options
the file all the connection data will be written to

Default
a file named 'connection.yml'
A file named ``connection.yml``.

.. code-block:: yaml

Expand Down
8 changes: 4 additions & 4 deletions source/reference/files/submit-yml/script.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ script.
be available to override in batch connect applications.

For example, ``workdir`` is set by the OnDemand system in batch
connect applications, and cannot be overidden.
connect applications, and cannot be overridden.

.. tip::
If you're using the ``ood_core`` gem (where all these are defined and used)
Expand Down Expand Up @@ -101,17 +101,17 @@ Note the use of ERB templates throughout these examples.

.. describe:: rerunnable (Boolean, nil)

Indicate whether the job is rerunnable.
Indicate whether the job is re-runnable.

Default
Empty, it is not rerunnable.
Empty, it is not re-runnable.

.. code-block:: yaml

rerunnable: nil

Example
The job is rerunnable.
The job is re-runnable.

.. code-block:: yaml

Expand Down
48 changes: 24 additions & 24 deletions source/reference/files/submit-yml/vnc-bc-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,43 +32,43 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be

.. describe:: websockfiy_cmd (String, "/opt/websockify/run")

the command to start websockify
the command to start ``websockify``.

Default
the '/opt/websockify/run' command
The ``/opt/websockify/run`` command.

.. code-block:: yaml

websockfiy_cmd: "/opt/websockify/run"

Example
the '/usr/bin/websockify' command
The ``/usr/bin/websockify`` command.

.. code-block:: yaml

websockify_cmd: "/usr/bin/websockify"

.. describe:: vnc_passwd (String, "vnc.passwd")

the file vncserver will read for a password
the file ``vncserver`` will read for a password

Default
a file named 'vnc.passwd'
a file named ``vnc.passwd``.

.. code-block:: yaml

vnc_passwd: "vnc.passwd"

Example
a file named 'my-other-vnc.passwd'
a file named ``my-other-vnc.passwd``.

.. code-block:: yaml

vnc_passwd: "my-other-vnc.passwd"

.. describe:: vnc_args (String, "")

vnc arguments to use instead of the specific options
VNC arguments to use instead of the specific options
``name``, ``geometry``, ``dpi``, ``fonts``, ``idle`` and
``extra_args``.

Expand All @@ -80,7 +80,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
vnc_args: ""

Example
only specify the xstartup option
Only specify the ``xstartup`` option.

.. code-block:: yaml

Expand All @@ -91,14 +91,14 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
the desktop name

Default
do not specify name, vncserver defaults to ``host:display# (username)``
do not specify name, ``vncserver`` defaults to ``host:display# (username)``

.. code-block:: yaml

name: ""

Example
boot vncserver with ``-name ood-$USER-$DISPLAY`` argument
boot ``vncserver`` with ``-name ood-$USER-$DISPLAY`` argument.

.. code-block:: yaml

Expand All @@ -109,14 +109,14 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
the geometry size of the VNC desktop

Default
do not specify geometry, turbovnc defaults to ``1240x900``
do not specify geometry, TurboVNC defaults to ``1240x900``

.. code-block:: yaml

geometry: ""

Example
boot vncserver with ``-geometry 1920x1080`` argument
boot ``vncserver`` with ``-geometry 1920x1080`` argument.

.. code-block:: yaml

Expand All @@ -134,7 +134,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
dpi: ""

Example
boot vncserver with ``-dpi 96`` argument
boot ``vncserver`` with ``-dpi 96`` argument

.. code-block:: yaml

Expand All @@ -145,40 +145,40 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
the font path for X11 fonts

Default
do not specify -fp option
do not specify ``-fp`` option

.. code-block:: yaml

fonts: ""

Example
boot vncserver with ``-fp unix/:7100`` argument
boot ``vncserver`` with the ``-fp unix/:7100`` argument.

.. code-block:: yaml

fonts: "unix/:7100"

.. describe:: idle (String, "")

the idle timeout setting for the vncserver
the idle timeout setting for the ``vncserver``.

Default
do not specify -idletimeout option
do not specify ``-idletimeout`` option

.. code-block:: yaml

idle: ""

Example
boot vncserver with ``-idletimeout 3600`` argument
boot ``vncserver`` with ``-idletimeout 3600`` argument

.. code-block:: yaml

idle: "3600"

.. describe:: extra_args (String, "")

any extra arguments to pass into vncserver
any extra arguments to pass into ``vncserver``.

Default
do not specify extra arguments
Expand All @@ -188,7 +188,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
idle: ""

Example
set the color depth of the vncserver to 32, in addition to any
set the color depth of the ``vncserver`` to 32, in addition to any
other specific argument given above

.. code-block:: yaml
Expand All @@ -206,7 +206,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be
the connection parameters that will be written to the ``conn_file``

Default
'host', 'port', 'password', 'spassword', 'display' and 'websocket'
``host``, ``port``, ``password``, ``spassword``, ``display`` and ``websocket``.

.. code-block:: yaml

Expand All @@ -230,18 +230,18 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be

.. describe:: websockify_heartbeat_seconds (Integer, 30)

The duration in seconds websockify will wait to send heartbeats
The duration in seconds ``websockify`` will wait to send heartbeats
to the client.

Default
Websockify will send heartbeats every 30 seconds.
``websockify`` will send heartbeats every 30 seconds.

.. code-block:: yaml

websockify_heartbeat_seconds: 30

Example
Have websockfiy send heartbeats every 10 seconds.
Have ``websockfiy`` send heartbeats every 10 seconds.

.. code-block:: yaml

Expand Down
Loading
Loading