Merge pull request #8 from ian-jarrett/main

Ready for 23.12

README.md

@@ -1,46 +1,38 @@
-# NITA Robot 22.8
+[branch]: https://github.com/Juniper/nita/tree/23.12
+[readme]: https://github.com/Juniper/nita/blob/23.12/README.md
 
-Welcome to NITA 22.8.
+# NITA Robot 23.12
 
-Packages built from this branch will be nita-*-22.8-x where x is the packaging release.
-This branch also contains patches from other branches or minor modifications as required to support the stability and usability of the release.
-There are also some backwards compatibility packages here for ansible and robot that allow projects written for NITA 3.0.7 to work without having to make any changes.
+Welcome to NITA, an open source platform for automating the building and testing of complex networks.
 
-Note that NITA 22.8 backward compatible with NITA 21.7 projects, provided the correct ansible and robot containers are installed.
+# Release Notes
+The major change in this version is that all components now run within pods under the control of Kubernetes, rather than as Docker containers. Consequently we have updated the way that Robot runs because it is now controlled by Kubernetes instead of Docker. 
 
-# Copyright
-
-Copyright 2022, Juniper Networks, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Please refer to the [README][readme] for more details.
 
-# Stable releases
-
-The idea here is to provide multiple NITA based projects with a firm foundation that they can use to focus on solving customer problems rather than continually tweaking the underlying software.
-
-It allows NITA projects to declare exactly which version of NITA they are compatible with.
+# Installing
 
-Projects must explicitly use the versions of the containers provided by this package in order to avoid docker attempting to download from the registry.
-No containers tagged as "latest" are provided by the package.
+The simplest way to install nita-robot is by installing nita, which can be done by running the ``install.sh`` script located and in the parent [nita repo][branch] as described [here][readme].
 
-# Installing
+## Accessing the container
 
-## Dependencies
+You can access the nita-robot container via the shell, simply be running the following command:
 
-NITA depends on docker-ce and docker-compose.
+```
+user@host$ nita-cmd robot cli
+If you don't see a command prompt, try pressing enter.
+nita-robot:~# exit
+exit
+pod "nita-robot" deleted
+user@host$
+```
 
-* For the **docker-ce** instalation the instructions found here: https://docs.docker.com/engine/install/
-* It is recomended to follow this steps after installing docker-ce: https://docs.docker.com/engine/install/linux-postinstall/
-* To install **docker-compose** follow the instructions found here: https://docs.docker.com/compose/install/
+# Copyright
 
-## Installation
+Copyright 2024, Juniper Networks, Inc.
 
-If you do not have the the required files for your system refer to [BUILD.md](./BUILD.md) file for instructions on how to generate these files.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-# Misc
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-For more information on NITA releases refer to the [README.md](https://github.com/Juniper/nita-webapp/blob/main/README.md) for the NITA Webapp <link to that>
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

VERSION.txt

@@ -1 +1 @@
-22.8
+23.12

cli_scripts/nita-cmd_robot_cli_help

@@ -0,0 +1,18 @@
+#!/bin/bash
+# ********************************************************
+#
+# Project: nita-robot
+#
+# Copyright (c) Juniper Networks, Inc., 2024. All rights reserved.
+#
+# Notice and Disclaimer: This code is licensed to you under the Apache 2.0 License (the "License"). You may not use this code except in compliance with the License. This code is not an official Juniper product. You can obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.html
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Third-Party Code: This code may depend on other components under separate copyright notice and license terms. Your use of the source code for those components is subject to the terms and conditions of the respective license as noted in the Third-Party source code file.
+#
+# ********************************************************
+        echo -n "    nita-cmd robot cli => "
+        echo `cat <<EOT
+Access the shell of the robot container within a Kubernetes pod.
+EOT` >&2