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

ST-155, add nexus documentation #34

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ Projects
:hidden:

services/ait_performance_env
services/nexus_repository


Developer Services
Expand Down
44 changes: 22 additions & 22 deletions src/services/ait_performance_env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ AIT cluster

Cluster specs
=============
.. image:: cluster.png
.. image:: ait_performance_env/cluster.png

Access the cluster
==================
Expand All @@ -22,20 +22,20 @@ In order to connect you will need an OpenVPN client:

Now just drag or add the .ovpn file to VPN the client. The follow tutorial is for tunnelblick, but it is similar to the other VPN clients.

.. image:: openvpn_open.png
.. image:: openvpn_more.png
.. image:: ait_performance_env/openvpn_open.png
.. image:: ait_performance_env/openvpn_more.png

Now that you have configured the VPN credentials click on the VPN client icon located at the toolbar and connect to the private network.

.. image:: openvpn_connect.png
.. image:: ait_performance_env/openvpn_connect.png

If all went okay, you are successfully connected.

.. image:: openvpn_success.png
.. image:: ait_performance_env/openvpn_success.png

Access to the OpenStack platform (Virtualization)
=================================================
.. image:: openstack_login.png
.. image:: ait_performance_env/openstack_login.png

The OpenStack platform requires authentication in order to use it.

Expand All @@ -47,48 +47,48 @@ Virtual machine deployment
--------------------------
- At the sidebar, go to Project -> Compute -> Instances and click on the "Launch Instance" button:

.. image:: openstack_project_compute_instance.png
.. image:: ait_performance_env/openstack_project_compute_instance.png

- At this stage a menu will pop-up and will ask to specify virtual machine caracteristics, chose an name for virtual machine:

.. image:: openstack_vm_chars.png
.. image:: ait_performance_env/openstack_vm_chars.png

- Select the Operating System you want your VM to have:

**NOTE: Please choose the option "Yes" at "Delete Volume on Instance Delete" so when you decide to delete the instance the volume will be also deleted and not occupy unnecessary space**

.. image:: openstack_vm_os.png
.. image:: openstack_vm_os2.png
.. image:: ait_performance_env/openstack_vm_os.png
.. image:: ait_performance_env/openstack_vm_os2.png

- Select the flavor which you want your VM to have:

.. image:: openstack_flavor.png
.. image:: openstack_flavor2.png
.. image:: ait_performance_env/openstack_flavor.png
.. image:: ait_performance_env/openstack_flavor2.png

- Select private network (int-net):

.. image:: openstack_network.png
.. image:: openstack_network2.png
.. image:: ait_performance_env/openstack_network.png
.. image:: ait_performance_env/openstack_network2.png

- Create or use ssh key to enable ssh access to the VM:

.. image:: openstack_sshkeys.png
.. image:: ait_performance_env/openstack_sshkeys.png

- In the end press on "Launch Instance" button at the bottom. This initiates the virtual machine deployment. It could take a while:

.. image:: openstack_launch_instance.png
.. image:: ait_performance_env/openstack_launch_instance.png

- When the Power State become "Running", the virtual machine has been successfully deployed and is ready to be used:

.. image:: openstack_running_intance.png
.. image:: ait_performance_env/openstack_running_intance.png

- Since the VM is deployed inside private network you will need to associate Floating IP from your network have the access:

.. image:: openstack_running_intance.png
.. image:: openstack_floating_choose.png
.. image:: openstack_floating_add.png
.. image:: openstack_floating_add2.png
.. image:: openstack_floating_ip.png
.. image:: ait_performance_env/openstack_running_intance.png
.. image:: ait_performance_env/openstack_floating_choose.png
.. image:: ait_performance_env/openstack_floating_add.png
.. image:: ait_performance_env/openstack_floating_add2.png
.. image:: ait_performance_env/openstack_floating_ip.png

- Now using any SSH client connect to the instance through VPN using the Floating IP address

Expand Down
86 changes: 86 additions & 0 deletions src/services/nexus_repository.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
Nexus OSS Repository
********************

Repository address
==================
https://nexus.engageska-portugal.pt

.. image:: nexus_repository/nexus-oss.png

Repository formats
=================================

PyPi
----
.. image:: nexus_repository/pypi.png

Docker
------
.. image:: nexus_repository/docker.png

Raw
---
Raw repository is intended for any type and size of file. The main usage of raw repository is intended for sharing and storage of files.

.. image:: nexus_repository/raw.png

APT
---
.. image:: nexus_repository/apt.png

Other available formats
-----------------------
.. image:: nexus_repository/other.png

Repository upload (through browser)
===================================

If you have a Nexus user and the user has rights to upload, you may upload your file using an ordinary browser. Without Nexus user you may only list and download files.

In order to upload the file you need to click on "Upload" and then select the repository.

.. image:: nexus_repository/nexus-upload.png

PyPi
----
To upload PyPi content, click on "Browse" and select file to upload.

.. image:: nexus_repository/pypi-upload.png

Raw
---
To upload a raw file, click on "Browse" and select file to upload. You also must specify the path for the file.

.. image:: nexus_repository/raw-upload.png

Repository upload (through command line)
========================================

PyPi
----
Uploading a PyPi package into the nexus repo can be done using python tool called "twine".
To install it you can use "pip":
.. code:: bash

pip install twine

In order to upload the package using twine you must specify the "--repository-url" and the "package name"

.. code:: bash

twine upload --repository-url https://nexus.engageska-portugal.pt/repository/pypi/ pelican-2.4.4.tar.gz

It will be prompted for your Nexus user credentials.

.. image:: nexus_repository/pypi-twine-upload.png

Repository download
===================

PyPi
----
.. code:: bash

pip install -i https://nexus.engageska-portugal.pt/repository/pypi/simple flask

.. image:: nexus_repository/pypi-download.png
Binary file added src/services/nexus_repository/apt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/services/nexus_repository/docker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/services/nexus_repository/nexus-oss.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/services/nexus_repository/nexus-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/services/nexus_repository/other.png
Binary file added src/services/nexus_repository/pypi-download.png
Binary file added src/services/nexus_repository/pypi-upload.png
Binary file added src/services/nexus_repository/pypi.png
Binary file added src/services/nexus_repository/raw-upload.png
Binary file added src/services/nexus_repository/raw.png