Skip to content

Commit

Permalink
Remove ACS and AKS functionality (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
@timja
timja authored Mar 27, 2021
1 parent 7f42c5c commit 2afdce2
Show file tree
Hide file tree
Showing 72 changed files with 22 additions and 3,559 deletions.
137 changes: 16 additions & 121 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,125 +2,15 @@

> ***Important***: This plug-in is maintained by the Jenkins community and won’t be supported by Microsoft as of February 29, 2024.
Azure Container Agents Plugin can help you to run a container as an agent in Jenkins

We have two different orchestrators:
* Azure Container Service (Kubernetes)
* Azure Container Instance
Azure Container Agents Plugin can help you to run a container instance as an agent in Jenkins

## How to install
You can install/update this plugin in Jenkins update center (Manage Jenkins -> Manage Plugins, search Azure Container Agents Plugin).

You can also manually install the plugin if you want to try the latest feature before it's officially released. To manually install the plugin:
1. Clone the repo and build:

mvn package
2. Open your Jenkins dashboard, go to Manage Jenkins -> Manage Plugins
3. Go to Advanced tab, under Upload Plugin section, click Choose File.
4. Select `azure-container-agents.hpi` in target folder of your repo, click Upload.
5. Restart your Jenkins instance after install is completed.

## Pre-requirements
* Service Principal: [Create Service Principal via Azure CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli?toc=%2fazure%2fazure-resource-manager%2ftoc.json)
* or Managed Service Identity: [Configure a VM Managed Service Identity (MSI) using the Azure portal](https://docs.microsoft.com/en-us/azure/active-directory/msi-qs-configure-portal-windows-vm)

## Azure Container Service (Kubernetes)

With Azure Container Service (Kubernetes), you can create a container in you Kubernetes Cluster as agent.

You need to create your own Kubernetes Cluster in Azure and maintain the number of nodes.

Now we support [Azure Container Service with Kubernetes](https://docs.microsoft.com/en-us/azure/container-service/kubernetes/) and [Azure Container Service (AKS)](https://docs.microsoft.com/en-us/azure/aks/) as well

You can also create containers in ACI using [aci-connector-k8s](https://github.com/Azure/aci-connector-k8s) (experimental).

## Pre-requirements
If using Azure Container Service (Kubernetes), you need to [create Azure Container Service with Kubernetes](https://docs.microsoft.com/en-us/azure/container-service/kubernetes/container-service-kubernetes-walkthrough) or [create Azure Container Service (AKS)](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough) on Azure.

## Configure the plugin
1. Jenkins -> Manage Jenkins -> Configure System
2. Press `Add a new cloud` and choose `Azure Container Service(Kubernetes)`
3. Specify `Cloud Name` and it should be unique.
4. Choose an existing `Azure Credential` or create a new credential.
5. Choose `Resource Group` and `Container Service Name`.
6. Specify `Namespace`
7. Choose an existing `ACS Credential` or create a new one. If you using Azure Container Service (AKS), then you don't need to choose `ACS Credential`. Or you can choose one of two different kinds of credentials:
* SSH Username with private key
* Microsoft Azure Container Service
8. Press `Test Connection` to make sure the configurations above are correct.

## Configure the Pod Template
Although Kubernetes supports multi-containers in a Pod, but we only support one container per pod now.

Please ensure JenkinsURL, secret and nodeName passed to container via arguments or environment variables.

1. Specify `Name` and `Labels`
2. Choose a `Docker image`. Please note that the agent will connect with master via JNLP, so make sure JNLP installed in image. Default image is `jenkins/inbound-agent` and you can also use it as base image.
3. If you use a private registry, you need to specify a credential and you have two choices:
* Use a Private Registry Secret. You need to [create a Secret](https://kubernetes.io/docs/concepts/configuration/secret/) in your Kubernetes cluster in advance and then fill in the Secret name.
* Use a Private Registry Credential. You just need to fill in the credential and we will create a Secret for you.
4. Specify a `Command` to override the ENTRYPOINT or leave it blank.
5. Specify the `Arguments`. `${rootUrl}`, `${secret}` and `${nodeName}` will be replace with JenkinsUrl, Secret and ComputerNodeName automatically.
6. Specify the `Working Dir`. It's the root dir of you job. You must ensure login user have the write permission to this directory.
7. Add Environment Variables and Volumes. Please find details in help and you may need some manual operation to use specific Volumes.
8. Choose a retention strategy. You can get details in help.
9. Specify node where the container create on. If using Azure Disk or using aci-connector-k8s, you need to specify a node.
10. Check whether to run container in privileged mode.
11. Specify Request / Limit of the resource Cpu / Memory. Find details in [Managing Compute Resources for Containers](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/)

## Use Aci-Connector-k8s(experimental)
Please note this software is experimental and should not be used for anything resembling a production workload.

1. Clone and Install [aci-connector-k8s](https://github.com/Azure/aci-connector-k8s).
2. Specify `aci-connector` in `Specify Node`. Then all the container of this Pod Template will be created in ACI.

Only very few configurations are supported now.

## Configure Azure Container Service (Kubernetes) via Groovy Script
If you want to configure Azure Container Service (Kubernetes) via script rather than manually configure it in UI.
You can use the sample below in Manage Jenkins -> Script Console. The sample only contains a few of arguments. Find all the arguments in folder [builders](src/main/java/com/microsoft/jenkins/containeragents/builders/).
```groovy
import com.microsoft.jenkins.containeragents.builders.*
def myCloud = new KubernetesCloudBuilder()
.withCloudName("mycloud")
.withAzureCredentialsId("<Azure Credentials Id>")
.withResourceGroup("myResourceGroup")
.withServiceName("myServiceName")
.withAcsCredentialsId("<ACS Credentials Id>")
.addNewTemplate()
.withName("mytemplate")
.withLabel("k8s")
.endTemplate()
.build()
Jenkins.getInstance().clouds.add(myCloud)
```
```groovy
//inherit template from existing template
import com.microsoft.jenkins.containeragents.builders.*
def baseTemplate = new PodTemplateBuilder()
.withImage("privateImage")
.addNewImagePullSecret("yourSecret")
.addNewEnvVar("key", "value")
.build()
def myCloud = new KubernetesCloudBuilder()
.withCloudName("mycloud")
.withAzureCredentialsId("<Azure Credentials Id>")
.withResourceGroup("myResourceGroup")
.withServiceName("myServiceName")
.withAcsCredentialsId("<ACS Credentials Id>")
.addNewTemplateLike(baseTemplate)
.withName("mytemplate")
.withLabel("k8s")
.endTemplate()
.build()
Jenkins.getInstance().clouds.add(myCloud)
```

## Azure Container Instance

[Azure Container Instances](https://docs.microsoft.com/en-us/azure/container-instances/) offers the fastest and simplest way to run a container in Azure, without having to provision any virtual machines and without having to adopt a higher-level service.
Expand All @@ -139,17 +29,17 @@ Jenkins.getInstance().clouds.add(myCloud)
1. Specify `Name` and `Labels`
2. Set `Startup Timeout`.
3. Select `Image OS Type`, Windows or Linux.
4. Fill in `Docker Image`. Please note that the agent will connect with master via JNLP, so make sure JNLP installed in image. Default image is `jenkins/inbound-agent` and you can also use it as base image.
4. Fill in `Docker Image`. The default image is `jenkins/inbound-agent` and you can also use it as base image.
5. If you use a private registry, you need to specify a credential.
6. Specify a `Command`. Now the `Command` will override the ENTRYPOINT. `Arguments`. `${rootUrl}`, `${secret}` and `${nodeName}` will be replace with JenkinsUrl, Secret and ComputerNodeName automatically.
7. Specify the `Working Dir`. You must ensure login user have the write permission to this directory.
8. Add `Ports`, `Environment Variables` and `Volumes`
9. Choose a retention strategy. You can get details in help.
10. Specify `Cpu Requirement` and `Memory Requirement`, ACI containers costs per second. Find more detail in [Price Details](https://azure.microsoft.com/en-us/pricing/details/container-instances/).
6. Specify a `Command`. Now the `Command` will override the ENTRYPOINT. `Arguments`. `${rootUrl}`, `${secret}`, `${instanceIdentity}` and `${nodeName}` will be replaced with JenkinsUrl, Secret, [Instance identity](https://github.com/jenkinsci/instance-identity-plugin) and ComputerNodeName automatically.
7. Specify the `Working Dir`. Ensure the user has write permission to this directory.
8. Add `Ports`, `Environment Variables` and `Volumes` as needed.
9. Choose a retention strategy. You can get details by clicking the help icon.
10. Specify `CPU Requirement` and `Memory Requirement`, ACI containers costs per second. Find more details in [Container Instances pricing](https://azure.microsoft.com/en-us/pricing/details/container-instances/).

## Configure Azure Container Instance via Groovy Script
If you want to configure Azure Container Instance via script rather than manually configure it in UI.
You can use the sample below in Manage Jenkins -> Script Console. The sample only contains a few of arguments. Find all the arguments in folder [builders](src/main/java/com/microsoft/jenkins/containeragents/builders/).

You can use the sample below in Manage Jenkins -> Script Console. The sample only contains a few arguments. Find all the arguments in the [builders](src/main/java/com/microsoft/jenkins/containeragents/builders/) package.
```groovy
import com.microsoft.jenkins.containeragents.builders.*
Expand All @@ -165,7 +55,7 @@ def myCloud = new AciCloudBuilder()
.endTemplate()
.build()
Jenkins.getInstance().clouds.add(myCloud)
Jenkins.get().clouds.add(myCloud)
```
```groovy
//inherit template from existing template
Expand All @@ -187,9 +77,14 @@ def myCloud = new AciCloudBuilder()
.endTemplate()
.build()
Jenkins.getInstance().clouds.add(myCloud)
Jenkins.get().clouds.add(myCloud)
```

<!-- remove this section after August 2021 -->
## Azure Kubernetes Service

If you were previously using this plugin to integrate with AKS you should use the [Kubernetes plugin](https://plugins.jenkins.io/kubernetes/) instead.

## Data/Telemetry

Azure Container Agents Plugin collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](http://go.microsoft.com/fwlink/?LinkId=521839) to learn more.
Expand Down
38 changes: 1 addition & 37 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<packaging>hpi</packaging>

<name>Azure Container Agents Plugin</name>
<description>A Jenkins plugin to provisions agents on Azure Container Service and Azure Container Instances</description>
<description>Provisions agents on Azure Container Instances</description>
<url>https://github.com/jenkinsci/azure-container-agents-plugin</url>
<licenses>
<license>
Expand Down Expand Up @@ -86,42 +86,6 @@
<artifactId>cloud-stats</artifactId>
<version>0.26</version>
</dependency>
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
</dependency>
<dependency>
<groupId>io.fabric8</groupId>
<artifactId>kubernetes-client</artifactId>
<version>2.6.3</version>
<exclusions>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
</exclusion>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</exclusion>
<exclusion>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
</exclusion>
<exclusion>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>logging-interceptor</artifactId>
</exclusion>
</exclusions>
</dependency>

<!-- jenkins plugins -->
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
Expand Down
166 changes: 0 additions & 166 deletions src/main/java/com/microsoft/jenkins/containeragents/KubernetesAgent.java
View file

This file was deleted.

Loading

0 comments on commit 2afdce2

Please sign in to comment.