Initial commit

sventschui · Sep 8, 2019 · f1963bf · f1963bf
commit f1963bf
Show file tree

Hide file tree

Showing 22 changed files with 1,763 additions and 0 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,5 @@
+target/
+Dockerfile
+.dockerignore
+*.iml
+.idea/
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+.idea/
+*.iml
+target/
+
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,28 @@
+FROM maven:3.6-jdk-8-slim as build
+
+WORKDIR /
+
+ADD pom.xml ./
+
+RUN mvn clean compile
+
+ADD src ./src
+
+RUN mvn verify
+
+FROM sonatype/nexus3:3.18.1
+
+ARG NEXUS_CASC_VERSION=3.18.1-01
+ENV NEXUS_CASC_VERSION=$NEXUS_CASC_VERSION
+
+USER 0
+
+RUN echo "reference\:file\:nexus-casc-plugin-${NEXUS_CASC_VERSION}.jar = 199" >> /opt/sonatype/nexus/etc/karaf/startup.properties
+
+COPY --from=build --chown=root:root /target/nexus-casc-plugin-${NEXUS_CASC_VERSION}.jar /opt/sonatype/nexus/system/nexus-casc-plugin-${NEXUS_CASC_VERSION}.jar
+
+COPY default-nexus.yml /opt/nexus.yml
+
+ENV NEXUS_CASC_CONFIG=/opt/nexus.yml
+
+USER nexus
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2019 Sven Tschui
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,298 @@
+# Nexus Configuration as Code
+
+Nexus CasC is a configuration as code plugin for sonatype nexus 3.
+
+This plugin allows to specify a YAML file to configure a Nexus instance on startup.
+
+## Usage
+
+### Docker
+
+When using docker the easiest way to get started is to use the `sventschui/nexus-casc` image that inherits form `sonatype/nexus3`.
+
+The docker image supports the same options as the `sonatype/nexus3` image plus the following additions.
+
+It expects a YAML configuration file to be mounted to `/opt/nexus.yml` (This path can be overridden using the `NEXUS_CASC_CONFIG` env var).
+
+The format of the YAML file is documented below.
+
+### Manual installation
+
+Download the Nexus CasC plugin [here TODO](TODO) and copy it into the `systems` folder of your nexus installation.
+This folder resides in `/opt/sonatype/nexus/system/` when using the `sonatype/nexus3` docker image.
+
+Append the following line to the `etc/karaf/startup.properties` (`/opt/sonatype/nexus/etc/karaf/startup.properties` in the `sonatype/nexus3` docker image) file. 
+Replace the `<NEXUS_CASC_VERSION>` placeholder with the version of the Nexus CasC plugin you downloaded. 
+
+```
+reference\:file\:nexus-casc-plugin-<NEXUS_CASC_VERSION>.jar = 199
+```
+
+Create a YAML configuration file (as documented below) and add its path to the `NEXUS_CASC_CONFIG`
+environment variable.
+
+Now you can start Nexus as usual.
+
+## Configuration file
+
+You can find an example configuration file [here](https://github.com/sventschui/nexus-casc-plugin/blob/master/default-nexus.yml).
+
+Use ${ENV_VAR} for env var interpolation.
+
+The configuration file supports following options:
+
+### Core
+
+```yaml
+core:
+  baseUrl: "" # Nexus base URL
+  httpProxy: "" # HTTP proxy (Note: Basic Auth and NTLM are not yet supported, file an issue if you require this)
+  httpsProxy: ""  # HTTP proxy
+  nonProxyHosts: "" # Comma separated list of hosts not to be queried through a proxy
+```
+
+### Security
+
+```yaml
+security:
+  anonymousAccess: false # Enable/Disable anonymous access
+  pruneUsers: true # True to delete users not part of this configuration file
+  realms: # Authentication realms, tested for rutauth-realm only
+    - name: rutauth-realm
+      enabled: true
+  users:
+    - username: johndoe
+      firstName: John
+      lastName: Doe
+      password: ${USER_JOHNDOE_PASSWORD}
+      updateExistingPassword: false # True to update passwords of existing users, otherwise password is only used when creating a user
+      email: [email protected]
+      roles:
+        - source: ""
+          role: nx-admin
+```
+
+
+### Repository
+
+```yaml
+repository:
+  pruneBlobStores: true # True to delete blob stores not present in this configuration file
+  blobStores: # List of blob stores to create
+    - name: maven
+      type: File
+      attributes:
+        file:
+          path: maven
+        blobStoreQuotaConfig:
+          quotaLimitBytes: 10240000000
+          quotaType: spaceUsedQuota
+    - name: npm
+      type: File
+      attributes:
+        file:
+          path: npm
+        blobStoreQuotaConfig:
+          quotaLimitBytes: 10240000000
+          quotaType: spaceUsedQuota
+    - name: docker
+      type: File
+      attributes:
+        file:
+          path: docker
+        blobStoreQuotaConfig:
+          quotaLimitBytes: 10240000000
+          quotaType: spaceUsedQuota
+  pruneCleanupPolicies: true # True to delete cleanup policies not present in this configuration file 
+  cleanupPolicies:
+    - name: cleanup-maven-proxy
+      format: maven2
+      notes: ''
+      criteria:
+        lastDownloadBefore: 10
+    - name: cleanup-npm-proxy
+      format: npm
+      notes: ''
+      criteria:
+        lastDownloadBefore: 10
+    - name: cleanup-docker-proxy
+      format: docker
+      notes: ''
+      criteria:
+        lastDownloaded: 864000
+  pruneRepositories: true # True to delete repositories not present in this configuration file
+  repositories:
+    - name: npm-proxy
+      online: true
+      recipeName: npm-proxy
+      attributes:
+        proxy:
+          remoteUrl: https://registry.npmjs.org
+          contentMaxAge: -1.0
+          metadataMaxAge: 1440.0
+        httpclient:
+          blocked: false
+          autoBlock: true
+          connection:
+            useTrustStore: false
+        storage:
+          blobStoreName: npm
+          strictContentTypeValidation: true
+        routingRules:
+          routingRuleId: null
+        negativeCache:
+          enabled: true
+          timeToLive: 1440.0
+        cleanup:
+          policyName: cleanup-npm-proxy
+    - name: npm-hosted
+      online: true
+      recipeName: npm-hosted
+      attributes:
+        storage:
+          blobStoreName: npm
+          strictContentTypeValidation: true
+          writePolicy: ALLOW_ONCE
+        cleanup:
+          policyName: None
+    - name: npm
+      online: true
+      recipeName: npm-group
+      attributes:
+        storage:
+          blobStoreName: npm
+          strictContentTypeValidation: true
+        group:
+          memberNames:
+           - "npm-proxy"
+           - "npm-hosted"
+    - name: maven-snapshots
+      online: true
+      recipeName: maven2-hosted
+      attributes:
+        maven:
+          versionPolicy: SNAPSHOT
+          layoutPolicy: STRICT
+        storage:
+          writePolicy: ALLOW
+          strictContentTypeValidation: false
+          blobStoreName: maven
+    - name: maven-central
+      online: true
+      recipeName: maven2-proxy
+      attributes:
+        proxy:
+          contentMaxAge: -1
+          remoteUrl: https://repo1.maven.org/maven2/
+          metadataMaxAge: 1440
+        negativeCache:
+          timeToLive: 1440
+          enabled: true
+        storage:
+          strictContentTypeValidation: false
+          blobStoreName: maven
+        httpClient:
+          connection:
+            blocked: false
+            autoBlock: true
+        maven:
+          versionPolicy: RELEASE
+          layoutPolicy: PERMISSIVE
+        cleanupPolicy:
+          name: cleanup-maven-proxy
+        httpclient:
+        maven-indexer:
+    - name: maven-tudelft
+      online: true
+      recipeName: maven2-proxy
+      attributes:
+        proxy:
+          contentMaxAge: -1
+          remoteUrl: https://simulation.tudelft.nl/maven/
+          metadataMaxAge: 1440
+        negativeCache:
+          timeToLive: 1440
+          enabled: true
+        storage:
+          strictContentTypeValidation: false
+          blobStoreName: maven
+        httpClient:
+          connection:
+            blocked: false
+            autoBlock: true
+        maven:
+          versionPolicy: RELEASE
+          layoutPolicy: PERMISSIVE
+        cleanupPolicy:
+          name: cleanup-maven-proxy
+        httpclient:
+        maven-indexer:
+    - name: maven-public
+      online: true
+      recipeName: maven2-group
+      attributes:
+        maven:
+          versionPolicy: MIXED
+        group:
+          memberNames:
+           - "maven-central"
+           - "maven-snapshots"
+           - "maven-tudelft"
+        storage:
+          blobStoreName: maven
+    - name: docker-hosted
+      online: true
+      recipeName: docker-hosted
+      attributes:
+        docker:
+          forceBasicAuth: true
+          v1Enabled: false
+        storage:
+          blobStoreName: docker
+          strictContentTypeValidation: true
+          writePolicy: ALLOW_ONCE
+        cleanup:
+          policyName: None
+    - name: docker-proxy
+      online: true
+      recipeName: docker-proxy
+      attributes:
+        docker:
+          forceBasicAuth: true
+          v1Enabled: false
+        proxy:
+          remoteUrl: https://registry-1.docker.io
+          contentMaxAge: -1.0
+          metadataMaxAge: 1440.0
+        dockerProxy:
+          indexType: REGISTRY
+        httpclient:
+          blocked: false
+          autoBlock: true
+          connection:
+            useTrustStore: false
+        storage:
+          blobStoreName: docker
+          strictContentTypeValidation: true
+        routingRules:
+          routingRuleId: null
+        negativeCache:
+          enabled: true
+          timeToLive: 1440.0
+        cleanup:
+          policyName: cleanup-docker-proxy
+    - name: docker
+      online: true
+      recipeName: docker-group
+      attributes:
+        docker:
+          forceBasicAuth: true
+          v1Enabled: false
+        storage:
+          blobStoreName: docker
+          strictContentTypeValidation: true
+        group:
+          memberNames:
+            - "docker-hosted"
+            - "docker-proxy"
+```
-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    .idea/
+    *.iml
+    target/