From ff2ce48e5d8c591df175d189b31ab42909a70e64 Mon Sep 17 00:00:00 2001 From: Ryan Prout Date: Thu, 28 May 2020 12:36:46 -0400 Subject: [PATCH 1/4] initial ecp ci document commit --- .../ecp_ci/ci_details.rst | 3 ++ .../ecp_ci/getting_started.rst | 37 +++++++++++++++++++ services_and_applications/ecp_ci/index.rst | 11 ++++++ services_and_applications/ecp_ci/overview.rst | 11 ++++++ services_and_applications/index.rst | 3 +- 5 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 services_and_applications/ecp_ci/ci_details.rst create mode 100644 services_and_applications/ecp_ci/getting_started.rst create mode 100644 services_and_applications/ecp_ci/index.rst create mode 100644 services_and_applications/ecp_ci/overview.rst diff --git a/services_and_applications/ecp_ci/ci_details.rst b/services_and_applications/ecp_ci/ci_details.rst new file mode 100644 index 00000000..347f6412 --- /dev/null +++ b/services_and_applications/ecp_ci/ci_details.rst @@ -0,0 +1,3 @@ +********************** +ECP CI Details at OLCF +********************** \ No newline at end of file diff --git a/services_and_applications/ecp_ci/getting_started.rst b/services_and_applications/ecp_ci/getting_started.rst new file mode 100644 index 00000000..74753eb6 --- /dev/null +++ b/services_and_applications/ecp_ci/getting_started.rst @@ -0,0 +1,37 @@ +*********************************** +Getting Started with ECP CI at OLCF +*********************************** + +It is important to note that ECP CI capabilities are currently limited to the :ref:`ascent-user-guide` system. The ability to enable this on Summit is a work in progress. + +Getting Your Project Setup for ECP CI at OLCF +--------------------------------------------- + +An important realization is that NCCS has two separate enclaves, Open and Moderate, with different resources. The ECP CI capability is only enabled in the Open enclave at this time, running on the :ref:`ascent-user-guide` system, not the Moderate enclave (Summit). + +This is important because you may already have a project setup within NCCS, for accessing Summit. If so, this project needs to be mirrored to the Open enclave for working with ECP CI on Ascent (assuming that is the project code you want to setup to use the ECP CI framework). + +So, the first thing is to establish a project in the NCCS Open Enclave. There are two options for this: + + - Mirror an existing project from Moderate to Open for ECP CI + - Request a new project to be created in the Open enclave for ECP CI + +For both of these options please email `accounts@ccs.ornl.gov `_ to initate the request. + +**What to include in the request(s):** + + For mirroring: + + - The project PI (they need to approave the mirror request) + - The Project ID + - Statement that this is for ECP CI + + For new project request: + + - Name of the project + - Project PI + - Initial users + + +What Accounds Do I Need +----------------------- diff --git a/services_and_applications/ecp_ci/index.rst b/services_and_applications/ecp_ci/index.rst new file mode 100644 index 00000000..ee7d4a22 --- /dev/null +++ b/services_and_applications/ecp_ci/index.rst @@ -0,0 +1,11 @@ +************************** +ECP Continuous Integration +************************** + + +.. toctree:: + :maxdepth: 2 + + overview + getting_started + ci_details \ No newline at end of file diff --git a/services_and_applications/ecp_ci/overview.rst b/services_and_applications/ecp_ci/overview.rst new file mode 100644 index 00000000..58183e92 --- /dev/null +++ b/services_and_applications/ecp_ci/overview.rst @@ -0,0 +1,11 @@ +*************** +ECP CI Overview +*************** + +The ECP Continuous Integration (CI) resources are based on `Gitlab's CI componenets `_, but enhanced for HPC centers. These `enahancements `_ were identified as critical, to improve the ability of application and software technology projects to test across diverse HPC architectures and software environments. + +You can find the central ECP CI Documentation, for all participating HPC Centers, at the main `ECP CI documentation page `_. + +The documentation you are looking at now is specific to OLCF's site-local model, to enable initial testing of ECP CI integration at OLCF. An overview of the different ECP CI models can be found `here `_. The `Federeated Model `_ being the model that integrates all participating HPC facilities. + +**The Federated Model is NOT enabled yet. Currently, the site-local model is the only accessible implementation at OLCF.** \ No newline at end of file diff --git a/services_and_applications/index.rst b/services_and_applications/index.rst index aaeae4d0..7d35d99f 100644 --- a/services_and_applications/index.rst +++ b/services_and_applications/index.rst @@ -7,4 +7,5 @@ Services and Applications .. toctree:: :maxdepth: 2 - slate/index.rst \ No newline at end of file + slate/index.rst + ecp_ci/index.rst \ No newline at end of file From fef396934868fe863fcf518663f27f5737d1b472 Mon Sep 17 00:00:00 2001 From: Ryan Prout Date: Thu, 28 May 2020 13:27:54 -0400 Subject: [PATCH 2/4] adding details about accounts and basic infra info --- .../ecp_ci/getting_started.rst | 37 ++++++++++++++++++- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/services_and_applications/ecp_ci/getting_started.rst b/services_and_applications/ecp_ci/getting_started.rst index 74753eb6..bac4dd1d 100644 --- a/services_and_applications/ecp_ci/getting_started.rst +++ b/services_and_applications/ecp_ci/getting_started.rst @@ -33,5 +33,38 @@ For both of these options please email `accounts@ccs.ornl.gov `_. + +This is different from your NCCS Account/User ID. + +**NOTE:** ORNL Staff do not need to create an account and can use their standard ORNL User ID. + +Applying For Project Access +--------------------------- + +To gain access to a project, fill out the `Account Request Form `_. + +**Please be sure to have this necessary information:** + + - Your ORNL Resource Account User ID + - The Project ID + - The Project PI + +Accessing the CI Infrastructure +------------------------------- + +Currently, ECP CI at OLCF is limited to the `code.ornl.gov `_ Gitlab Server. It is specifically limited to the "ecpcitest" `group `_, within that Gitlab Server. + +Your NCCS Open project needs to have a Gitlab project setup, within the "ecpcitest" group, on `code.ornl.gov `_. + +Once you have your NCCS Open Project setup, please submit a ticket to `help@olcf.ornl.gov `_ requesting the Gitlab project be setup. + +In the end, you should be able to log into these systems: + + - `code.ornl.gov `_ + - ssh @login1.ascent.olcf.ornl.gov + +**NOTE:** Both of these systems require you to use your ORNL Resource Account User ID. This is different than your NCCS User ID. From 8af158df8356ad367a7cee06cb26eeb7d63d9ed7 Mon Sep 17 00:00:00 2001 From: Tom Papatheodore Date: Thu, 28 May 2020 21:17:34 -0400 Subject: [PATCH 3/4] fixed a few typos in ECP CI overview section --- services_and_applications/ecp_ci/overview.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/services_and_applications/ecp_ci/overview.rst b/services_and_applications/ecp_ci/overview.rst index 58183e92..ce7af261 100644 --- a/services_and_applications/ecp_ci/overview.rst +++ b/services_and_applications/ecp_ci/overview.rst @@ -2,10 +2,10 @@ ECP CI Overview *************** -The ECP Continuous Integration (CI) resources are based on `Gitlab's CI componenets `_, but enhanced for HPC centers. These `enahancements `_ were identified as critical, to improve the ability of application and software technology projects to test across diverse HPC architectures and software environments. +The ECP Continuous Integration (CI) resources are based on `Gitlab's CI components `_, but enhanced for HPC centers. These `enhancements `_ were identified as critical, to improve the ability of application and software technology projects to test across diverse HPC architectures and software environments. You can find the central ECP CI Documentation, for all participating HPC Centers, at the main `ECP CI documentation page `_. -The documentation you are looking at now is specific to OLCF's site-local model, to enable initial testing of ECP CI integration at OLCF. An overview of the different ECP CI models can be found `here `_. The `Federeated Model `_ being the model that integrates all participating HPC facilities. +The documentation you are looking at now is specific to OLCF's site-local model, to enable initial testing of ECP CI integration at OLCF. An overview of the different ECP CI models can be found `here `_. The `Federated Model `_ being the model that integrates all participating HPC facilities. -**The Federated Model is NOT enabled yet. Currently, the site-local model is the only accessible implementation at OLCF.** \ No newline at end of file +**The Federated Model is NOT enabled yet. Currently, the site-local model is the only accessible implementation at OLCF.** From f1b94e48a44b16c6bcf072dc4d6d8b9f9f90f06e Mon Sep 17 00:00:00 2001 From: Tom Papatheodore Date: Thu, 28 May 2020 21:36:45 -0400 Subject: [PATCH 4/4] added minor clarification and fixed typos in ECP CI getting started section --- services_and_applications/ecp_ci/getting_started.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/services_and_applications/ecp_ci/getting_started.rst b/services_and_applications/ecp_ci/getting_started.rst index bac4dd1d..798b557f 100644 --- a/services_and_applications/ecp_ci/getting_started.rst +++ b/services_and_applications/ecp_ci/getting_started.rst @@ -7,7 +7,7 @@ It is important to note that ECP CI capabilities are currently limited to the :r Getting Your Project Setup for ECP CI at OLCF --------------------------------------------- -An important realization is that NCCS has two separate enclaves, Open and Moderate, with different resources. The ECP CI capability is only enabled in the Open enclave at this time, running on the :ref:`ascent-user-guide` system, not the Moderate enclave (Summit). +An important realization is that NCCS has two separate security enclaves, Open and Moderate, with different resources. The ECP CI capability is only enabled in the Open enclave at this time, running on the :ref:`ascent-user-guide` system, not the Moderate enclave (Summit). This is important because you may already have a project setup within NCCS, for accessing Summit. If so, this project needs to be mirrored to the Open enclave for working with ECP CI on Ascent (assuming that is the project code you want to setup to use the ECP CI framework). @@ -33,14 +33,14 @@ For both of these options please email `accounts@ccs.ornl.gov `_. +Accessing Ascent and working in the NCCS Open enclave requires an ORNL Resource Account (i.e., XCAMS or UCAMS). Users can register for an account at this `User Portal `_. -This is different from your NCCS Account/User ID. +This is different from your NCCS Account/User ID (i.e., the one you use to log into Summit). -**NOTE:** ORNL Staff do not need to create an account and can use their standard ORNL User ID. +**NOTE:** ORNL Staff do not need to create an account and can use their standard ORNL User ID (UCAMS). Applying For Project Access ---------------------------