Nokubeconfig needed in interlink + new doc with docusaurus

.github/workflows/pages.yaml

@@ -0,0 +1,43 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          #cache: yarn
+
+      - name: Install dependencies
+        run: cd docs-new && yarn install  --frozen-lockfile
+      - name: Build website
+        run: cd docs-new && yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docs-new/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

README.md

@@ -21,6 +21,8 @@ The project got inspired by the [KNoC](https://github.com/CARV-ICS-FORTH/knoc) p
 
 ## Quick references:
 - [:information\_source: Overview](#information_source-overview)
+  - [Watch for a quick tour](#watch-for-a-quick-tour)
+  - [Introduction](#introduction)
 - [Quick references:](#quick-references)
 - [:fast\_forward: Quick Start](#fast_forward-quick-start)
 - [:information\_source: InterLink Config file](#information_source-interlink-config-file)
@@ -99,7 +101,6 @@ A quick recap to the list of outgoing HTTP calls:
 | Call          |              Outgoing URL               |
 |---------------|:---------------------------------------:|
 | PingInterLink |      InterLinkUrl:InterLinkPort/ping    |
-| SetKubeConfig |   InterLinkUrl:InterLinkPort/setKubeCFG |
 | Create        |    InterLinkUrl:InterLinkPort/create    |
 | Delete        |    InterLinkUrl:InterLinkPort/delete    |
 | Status        |    InterLinkUrl:InterLinkPort/status    |
@@ -125,7 +126,6 @@ A quick recap to the list of HTTP calls:
 | Call          |             Incoming URL              |          Outgoing URL         |
 |---------------| :-----------------------------------: |:-----------------------------:|
 | Ping          |    InterLinkUrl:InterLinkPort/ping    |                               |
-| SetKubeConfig | InterLinkUrl:InterLinkPort/setKubeCFG |                               |
 | Create        |   InterLinkUrl:InterLinkPort/create   | SidecarURL:SidecarPort/create |
 | Delete        |   InterLinkUrl:InterLinkPort/delete   | SidecarURL:SidecarPort/delete |
 | Status        |   InterLinkUrl:InterLinkPort/status   | SidecarURL:SidecarPort/status |

cmd/interlink/main.go

@@ -37,7 +37,6 @@ func main() {
 	mutex.HandleFunc("/status", interlink.StatusHandler)
 	mutex.HandleFunc("/create", interlink.CreateHandler)
 	mutex.HandleFunc("/delete", interlink.DeleteHandler)
-	mutex.HandleFunc("/setKubeCFG", interlink.SetKubeCFGHandler)
 	mutex.HandleFunc("/ping", interlink.Ping)
 	mutex.HandleFunc("/getLogs", interlink.GetLogsHandler)
 	err := http.ListenAndServe(":"+commonIL.InterLinkConfigInst.Interlinkport, mutex)

docs-new/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs-new/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs-new/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs-new/docs/intro.md

@@ -0,0 +1,26 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+:::warning
+
+interLink is in early development phase, thus subject to breaking changes with no guarantee of backward compatibility.
+
+:::
+
+InterLink aims to provide an abstraction for the execution of a Kubernetes pod on any remote resource capable of managing a Container execution lifecycle.
+
+The project consists of two main components:
+
+- __A Kubernetes Virtual Node:__ based on the [VirtualKubelet](https://virtual-kubelet.io/) technology. Translating request for a kubernetes pod execution into a remote call to the interLink API server.
+- __The interLink API server:__ a modular and pluggable REST server where you can create your own Container manager plugin (called sidecars), or use the existing ones: remote docker execution on a remote host, singularity Container on a remote SLURM batch system.
+
+The project got inspired by the [KNoC](https://github.com/CARV-ICS-FORTH/knoc) project, enhancing that with the implemention a generic API layer b/w the virtual kubelet component and the provider logic for the container lifecycle management.
+
+Let's discover [**interLink in less than 5 minutes**](./category/tutorial---end-users).
+
+## What you'll need
+
+You need only a machine with [Docker](https://docs.docker.com/engine/install/) engine and git CLI installed.

docs-new/docs/tutorial-admins/01-deploy-interlink.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 1
+---
+
+# Deploy interLink virtual nodes
+
+Learn how to deploy interLink virtual nodes on your cluster.
+
+:::warning
+
+TBD
+
+:::

docs-new/docs/tutorial-admins/03-develop-a-plugin.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 2
+---
+
+# Develop an interLink plugin
+
+Learn how to adapt interLink plugins for your remote host.
+
+:::warning
+
+TBD
+
+:::

docs-new/docs/tutorial-admins/04-api-reference.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 3
+---
+
+# API reference
+
+Rerence of both interLink and plugins API.
+
+:::warning
+
+TBD
+
+:::

docs-new/docs/tutorial-admins/05-configuration-reference.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 4
+---
+
+# Configuration reference
+
+Rerence of both interLink and plugins configuration files.
+
+:::warning
+
+TBD
+
+:::

docs-new/docs/tutorial-admins/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Tutorial - Administators",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Learn how to adapt interLink plugins for your remote host."
+  }
+}