Connect to windows host from BP

Author: odx-pipelines/[email protected]

.gitignore

@@ -4,7 +4,8 @@
 **.idea**
 .AppleDouble
 .LSOverride
-
+Tests/*
+Tests
 # Icon must end with two \r
 Icon
 

AIO.md

@@ -1,5 +1,7 @@
 All in One reference for samples - In Alphabetical (A to Z) order.
 -----
+
+- A way (workaround) to execute commands on to a Windows machine using OCI Run command agent from OCI Build pipeline. - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-devops-connect-to-windows-from-buildmachines
 - Access resource with Private IP from OCI Build runner - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-devops-pa-with-private-oke
 - Build Caching - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci-build-caching
 - Build Native image with Graal VM Enterprise edition - https://github.com/oracle-devrel/oci-devops-examples/tree/main/oci-build-examples/oci_devops_build_with_graalenterprise

oci-build-examples/README.md

@@ -12,6 +12,13 @@ All about OCI devops build samples ..
 
 * [All about predefined system variables](./oci_build_parameters/)
 
+</details>
+<details>
+  <summary>Compute Agents executions</summary>
+
+* [Run commands on WINDOWS host from build pipeline](./oci-devops-connect-to-windows-from-buildmachines/)
+
+
 </details>
 
 <details>
@@ -44,6 +51,8 @@ All about OCI devops build samples ..
 
 
 
+
+
 ### Back to examples.
 ----
 

oci-build-examples/oci-devops-connect-to-windows-from-buildmachines/README.md

@@ -0,0 +1,158 @@
+A way (workaround) to execute commands on to a Windows machine using OCI Run command agent from OCI Build Pipeline
+------
+
+
+
+Objective
+---
+- Create an OCI DevOps build pipeline.
+- Create a windows host and enable compute run agent.
+- Execute commands on Windows hosts and fetch the result.
+
+   ```
+   $ git init oci-devops-connect-to-windows-from-buildmachines
+   $ cd oci-devops-connect-to-windows-from-buildmachines
+   $ git remote add origin <url to this git repo>
+   $ git config core.sparsecheckout true
+   $ echo "oci-build-examples/oci-devops-connect-to-windows-from-buildmachines/*">>.git/info/sparse-checkout
+   $ git pull --depth=1 origin main
+
+   ```
+
+Audience: OCI Advanced users.
+
+Procedure to use the illustration
+-------
+
+### Compute instance.
+
+- Create an OCI Compute instance with Windows operating system.
+
+![](images/oci-compute-instance-1.png)
+
+![](images/oci-compute-instance-2.png)
+
+- Provide `VCN`, and `Subnet` information. A public IP address is optional, as we will be using the `OCI Run command agent` it does not need a public IP address for the connection.
+
+- Ensure that the `Compute Instance Run command` agent is enabled.
+
+![](images/oci-compute-agent.png)
+
+### OCI identity setup.
+
+- Create a dynamic group for computing instance/s with the below rule.
+```java
+All {instance.compartment.id = 'OCID OF WINDOWS HOST'}
+```
+- Create a dynamic group for the DevOps build pipeline with the below rule.
+
+```java
+ALL {resource.type = 'devopsbuildpipeline', resource.compartment.id = 'OCID OF OCI COMPARTMENT'}
+```
+
+- Create the below identity policies.
+```java
+Allow dynamic-group <NAME OF THE DG FOR BUILD PIPELINE> to manage objects in compartment <NAME OF THE COMPARTMENT>
+        
+Allow dynamic-group <NAME OF THE DG FOR BUILD PIPELINE> to manage ons-topics in compartment <NAME OF THE COMPARTMENT>
+        
+Allow dynamic-group <NAME OF THE DG FOR BUILD PIPELINE> ons-topics in compartment <NAME OF THE COMPARTMENT>
+        
+Allow dynamic-group <NAME OF THE DG FOR COMPUTE INSTANCES> to use instance-agent-command-execution-family in compartment <NAME OF THE COMPARTMENT>
+        
+Allow dynamic group <NAME OF THE DG FOR COMPUTE INSTANCES> to manage objects in compartment <NAME OF THE COMPARTMENT>
+        
+Allow dynamic-group <NAME OF THE DG FOR COMPUTE INSTANCES> to use instance-agent-command-execution-family in compartment <NAME OF THE COMPARTMENT>
+
+```
+
+### Object Storage.
+
+- Create an `object storage bucket.
+
+![](images/oci-object-bucket.png)
+
+
+### OCI DevOps.
+- Create an OCI notification topic - https://docs.oracle.com/en-us/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createTopic
+
+- Create a DevOps project - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_project.htm#create_a_project
+
+![](images/oci-devops-project.png)
+
+- Enable logging for the DevOps project.
+
+![](images/oci-devops-logs.png)
+
+Click on Code Repository within the DevOps project resource and click on `Create repository. - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_repo.htm
+
+![](images/oci-code-repo.png)
+
+- Using the `ssh` or `https` method and push the whole content to the OCI Code repo - refer to details here - https://docs.oracle.com/en-us/iaas/Content/devops/using/clone_repo.htm
+
+- Click on Build pipelines within DevOps project resources and click on Create build pipeline- https://docs.oracle.com/en-us/iaas/Content/devops/using/managing_build_pipelines.htm
+
+![](images/oci-buildpipeline.png)
+
+- Use `+` and add a stage.
+
+![](images/oci-add-stage.png)
+
+- Add a `Managed Build stage`.
+
+![](images/oci-managed-build-stage.png)
+
+- Provide the details and connect to the `OCI Code repo` as the primary source name.
+
+![](images/oci-devops-add-source.png)
+
+- Click `Add`.
+
+- Add below `Build parameters` and actual values.
+
+```java
+- OBJECTSTORAGE_NAMESPACE: OBJECT STORAGE NAMESPACE
+- OBJECTSTORAGE_BUCKET: OBJECT BUCKET NAME
+- INSTANCE_OCID : COMPUTE INSTANCE(WINDOWS) OCID
+- OCI_REGION : OCI Region identifier
+```
+
+![](images/oci-build-params.png)
+
+
+### Validate the execution.
+
+- Within the `Build pipeline` click `Start manual run`
+
+![](images/oci-build-start.png)
+
+- Wait for all the steps to finish.
+
+- Validate the execution via build logs.
+- Verify the input and output file via object storage.
+  ![](images/oci-bucket-objects.png)
+- Verify the run command execution status via the instance `run command` option.
+  ![](images/oci-run-commands.png)
+- For any error during the execution you may do a trial run of `run command` against the compute instance from OCI Compute console view, validate the policies and groups and verify the build parameter
+- The `TIMEOUT_IN_SECONDS` value within build_spec.yaml file for the compute run command agent invoke is  based on samples here, please update accordingly
+
+
+Read more
+---
+
+- OCI DevOps service - https://docs.oracle.com/en-us/iaas/Content/devops/using/home.htm
+- OCI Compute run command agent - https://docs.oracle.com/en-us/iaas/Content/Compute/Tasks/runningcommands.htm
+
+Contributors
+===========
+
+- Author: [Rahul M R](https://github.com/RahulMR42).
+- Collaborators:
+- Last release: December 2022
+
+### Back to examples.
+----
+
+- 🍿 [Back to OCI Devops Build sample](./../README.md)
+- 🏝️ [Back to OCI Devops sample](./../../README.md)
+

oci-build-examples/oci-devops-connect-to-windows-from-buildmachines/build_spec.yaml

@@ -0,0 +1,59 @@
+version: 0.1
+component: build
+timeoutInSeconds: 6000
+runAs: root
+shell: bash
+env:
+  # these are local variables to the build config
+  variables:
+    LOCAL_CHECK_STATE: "SUCCEEDED" #Its a dummy variable for now ,but can be used if you wish to add more status checks across.
+    TIMEOUT_IN_SECONDS: 700 #Its a timeout for compute agent execution.
+
+steps:
+  - type: Command
+    name: " Update Object Storage"
+    timeoutInSeconds: 200
+    command: |
+      cd ${OCI_PRIMARY_SOURCE_DIR}
+      oci os object put --namespace ${OBJECTSTORAGE_NAMESPACE} --bucket-name ${OBJECTSTORAGE_BUCKET} --file input_windows.txt --no-multipart --force
+
+    # In the above step Using input_windows.txt file to push to object,if you wish to use different name ,please do update the content.json as well.
+
+  - type: Command
+    name: "OCI Instance Agent Inovkation"
+    timeoutInSeconds: 20000
+    command: |
+      cd ${OCI_PRIMARY_SOURCE_DIR}
+      export BUILDRUN_HASH=`echo ${OCI_BUILD_RUN_ID} | rev | cut -c 1-7`
+      if [ ! -e "instance.json" ] ; then
+          echo '{"instanceId": "'${INSTANCE_OCID}'"}' > instance.json
+
+      fi
+      cat content.json |envsubst >content_target.json
+      cat content_target.json
+      COMPARTMENT_OCID=$(oci devops build-pipeline get --build-pipeline-id $OCI_PIPELINE_ID --query "data.\"compartment-id\"" --raw-output)
+      oci instance-agent command create --compartment-id ${COMPARTMENT_OCID} --content file://content_target.json --target file://instance.json --timeout-in-seconds ${TIMEOUT_IN_SECONDS} --display-name "cmd_by_build_${BUILDRUN_HASH}"
+      echo "Invoked Command exec with a display - cmd_by_build_${BUILDRUN_HASH}"
+      echo "Sleeping for ${TIMEOUT_IN_SECONDS} seconds...."
+      sleep ${TIMEOUT_IN_SECONDS}
+
+
+  - type: Command
+    name: "Read from Object storage"
+    timeoutInSeconds: 10000
+    command: |
+      cd ${OCI_WORKSPACE_DIR}/${code_repo_name}
+      if [ "${LOCAL_CHECK_STATE}" != "FAILED" ] ;then
+        oci os object get --namespace ${OBJECTSTORAGE_NAMESPACE} --bucket-name ${OBJECTSTORAGE_BUCKET} --file from_object_store.txt --name output_windows.txt
+        echo """"""""""""""""""""""""""""""""Execution Output""""""""""""""""""""""""""""""""""""""""""""""""""
+        cat from_object_store.txt
+        echo """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+      fi
+      
+  # In the above steps ,reading the agent execution output from a file named output_windows.txt,for any changes ,do update the content.json as well.
+
+
+
+      
+     
+

oci-build-examples/oci-devops-connect-to-windows-from-buildmachines/content.json

@@ -0,0 +1,20 @@
+{
+  "output":
+  {
+    "bucketName": "${OBJECTSTORAGE_BUCKET}",
+    "namespaceName": "${OBJECTSTORAGE_NAMESPACE}",
+    "objectName": "output_windows.txt",
+    "outputType": "OBJECT_STORAGE_TUPLE",
+    "outputUri": "https://objectstorage.${OCI_REGION}.oraclecloud.com/n/${OBJECTSTORAGE_NAMESPACE}/b/${OBJECTSTORAGE_BUCKET}/o/output_windows.txt"
+  },
+
+  "source":
+  {
+    "bucketName": "${OBJECTSTORAGE_BUCKET}",
+    "namespaceName": "${OBJECTSTORAGE_NAMESPACE}",
+    "objectName": "input_windows.txt",
+    "sourceType": "OBJECT_STORAGE_TUPLE",
+    "sourceUri": "https://objectstorage.${OCI_REGION}.oraclecloud.com/n/${OBJECTSTORAGE_NAMESPACE}/b/${OBJECTSTORAGE_BUCKET}/o/input_windows.txt"
+  }
+
+}