Step 1 - Install and Configure
Contents
1. demands in time Step 1 Install and Configure 3 Sonatype CLM Server is an I O intensive application and disk speed will affect the performance of the CLM server considerably We therefore recommend to use local drives or SAN usage Usage of network mapped storage via NFS or similar is not recommended It is important to consider the I O load when running CLM server in a virtual machine especially when other virtual machines on the same host are running other I O intensive applications e g the Nexus repository manager Development test or evaluation deployments can be scaled smaller than the above recommendations and will continue to function while a minor performance degradation can be observed 2 2 Software Requirements 2 2 1 Operating System and Java Runtime Environment Sonatype CLM server requires a 64bit operating system due to its memory requirements Otherwise there are no specific requirements besides the availability of a JRE Sonatype CLM requires a Java 7 runtime environment Update 21 or higher from Oracle We recommend usage of the Server JRE A list of supported operating systems for the JRE is available from Oracle 2 2 2 Browser The Sonatype CLM Server exposes a web application for administration and configuration as well as for viewing reports Usage of this application requires Microsoft Internet Explorer 9 or higher or any other modern browser like newer versions of Mozilla Firefox Google Chrome or Appl2. granted An example command to achieve this for a service user with the username clmserver is chown Rv clmserver opt sonatype clm server If you have configured the sonat ypeWork parameter in config yml to point to a different directory you have to adjust the access rights for it as well The principal command for starting the CLM server can be used in a simple startup script as displayed in Startup Script The javaopts variable should be adjusted to suit the hardware used Step 1 Install and Configure 8 Startup Script bin sh cd opt sonatype clm server Javaopts Xmx1024m XX MaxPermSize 128m Java Sjavaopts jar sonatype clm server 1 10 2 jar server config yml A running server can be stopped with a simple shutdown script in Shutdown script Shutdown script bin sh pid ps aux grep sonatype clm server grep v grep awk print Say OS pia Typically these approaches are combined to a service script similar to the script listed in Simplistic Service Script for Unix Systems Saving this script as e g sonatype clm server allows you to start the server with its log running to the current shell with sonatype clm server console Starting as a background process can be initiated with sonatype clm server start and a running background server can be stopped with sonatype clm server stop This example script can be improved to be more robust against repeat invocations long running st
3. Step 1 Install and Configure Step 1 Install and Configure Step 1 Install and Configure Contents 1 Introduction 2 Preparation and Installation 2A 2 2 a3 2 4 25 2 6 ot 2 8 Hardware Prerequisites and Recommendations o Software Requirements 2 2 1 Operating System and Java Runtime Environment Zio BOWSER lt 6 o Download 6 kc ew ee Installation Starting CLM Server License Installation CLM Server Directories Running CLM Server as a Service Step 1 Install and Configure 2 9 Backup 2 10 Upgrading 3 Configuration 3 1 Initial Configuration of CLM Server e 3 2 Running the CLM Server Behind a HTTP Proxy Server o 3 2 Sethe the Base URL occ sa a ee a ee ae aes 34 Pile COnmIpUraiOn 2 ee ce bea Pe ed A de es J Emol onfiant asd din eS oe ee PGR e ee Ey erie Ob eed ae ee A 30 Losping ConmiaWration peso osea ed a ee Re we aT ATT Comngiratien 5425 464854 Fos PAE A Ee Re 3 8 HTTPS SSL 4 Conclusion 10 10 11 11 12 13 13 14 14 14 15 16 Step 1 Install and Configure List of Figures 2 1 Installing a Product License on Sonatype CLM Server 2 2 Sonatype CLM Server End User License Agreement Window 2 3 Installed Product License on Sonatype CLM Server Step 1 Install and C
4. be copied to a dedicated startup directory and assigned with run levels and other characteristics for the start up As an example on a Debian based systems the following commands could be used Step 1 Install and Configure 10 sudo su cp sonatype clm server etc init d el y Sue imit ael update rc d sonatype clm server defaults service sonatype clm server start Depending on the requirements from your system administrator the scripts will have to be modified to fit into your environment and exact deployment scenario 2 9 Backup The Sonatype CLM Server keeps all its configuration and data besides the startup configuration in the sonatypeWork folder as configured in config yml In a default deployment this folder will be the sonatype work clm server folder in your installation directory We recommend to use your backup system of choice to ensure availability of backups 2 10 Upgrading The following steps would complete an upgrade procedure for the Sonatype CLM Server 1 Stop the Sonatype CLM Server 2 Perform a backup 3 Make a copy of sonatype clm server config yml 4 Copy the new installation bundle into installation folder 5 Extract the bundle 6 Apply all modifications from the backup config yml to the new config yml file including e g server ports 7 Update any startup scripts as needed 8 Start the Sonatype CLM Server Step 1 Install and Configure 11 Chapter 3 Configuration The mai
5. e Safari 2 3 Download The latest release of the CLM Server can be downloaded from the Sonatype support website and is avail able as tar gz or zip archive The contents of the two files are identical and you can choose to download ei ther one Successful download should result in files named sonatype c1m server xyz bundle tar gz Step 1 Install and Configure 4 or sonatype clm server xyz bundle zip where xyz is the version of the latest release e g 1 9 0 030r1 10 2 2 4 Installation After a successful download of the CLM server bundle archive you should create an installation directory in the desired location and move the archive into the directory cd opt mkdir sonatype clm server mv Downloads sonatype clm server sonatpe clm server cd sonatype clm server Moving into the directory and extracting the archive with either one of the commands unzip sonatype clm serverx zip tar xfvz sonatype clm serverx tar gz should result in a directory with the following files README txt config yml demo bat demo sh eula html sonatype clm server 1 10 2 bundle tar gz sonatype clm server 1 10 2 jar 2 5 Starting CLM Server Once the CLM server is installed it can be started with cd opt sonatype clm server java jar sonatype clm server 1 10 2 jar server config yml This command will start the server with the Sonatype CLM Server application using the configuration from the config yml
6. file and logging any output straight to the console After a complete start your Step 1 Install and Configure 5 console should display a message similar to main org eclipse jetty server AbstractConnector Started InstrumentedBlockingChannelConnector 0 0 0 0 8070 main org eclipse jetty server AbstractConnector Started SocketConnector 0 0 0 0 8071 The command to start the server can be modified by adding java configurations parameters such as Xmx1024m XX MaxPermSize 128m to improve performance and adapt to the server hardware At this stage you can access the web application at port 8070 of your server via any web browser Initial startup will display a screen for the Section 2 6 2 6 License Installation Sonatype CLM server requires a license to be installed The required license file will be supplied to you by the Sonatype support team in the form of a lic file Open a web browser and navigate to the CLM server web application at port 8070 to install the license Opening the URL e g for a localhost deployment at http localhost 8070 displays the Product License Configuration of the CLM server shown in Figure 2 1 Product License O Install License Figure 2 1 Installing a Product License on Sonatype CLM Server Press the Install License button and select the 1ic file in the file selector As a next step you are required to accept the end user license agreement shown in Figure 2 2 by pressin
7. g the Accept button Step 1 Install and Configure 6 SONATYPE MASTER EULA AGREEMENT READ THIS AGREEMENT CAREFULLY BY CLICKING ON THE I ACCEPT OR SIMILAR CONSENT BUTTON OR A DOWNLOADING INSTALLING OR USING ALL OR ANY PORTION OF THE SONATYPE SOFTWARE B ACCEPTING OR USING ALL OR ANY PORTION OF THE SONATYPE CLM DATA SERVICE C ACCEPTING OR USING ALL OR ANY PORTION OF THE OPEN SOURCE SUPPORT OR D ACCEPTING OR USING ALL OR ANY PORTION OF THE SERVICES INCLUDING SUPPORT TRAINING COURSES OR PROFESSIONAL SERVICES YOU ARE ACCEPTING ALL OF THE TERMS AND CONDITIONS OF THIS AGREEMENT YOU AGREE THAT THIS AGREEMENT IS ENFORCEABLE LIKE ANY WRITTEN NEGOTIATED AGREEMENT SIGNED BY YOU IF YOU DO NOT AGREE TO ALL OF THESE TERMS AND CONDITIONS DO NOT CLICK TO ACCEPT OR OTHERWISE A DOWNLOAD INSTALL OR USE ALL OR ANY PORTION OF THE SONATYPE SOFTWARE B ACCEPT OR USE ALL OR ANY PORTION OF THE SONATYPE CLM DATA SERVICE C ACCEPT OR USE ALL OR ANY PORTION OF THE OPEN SOURCE SUPPORT OR D ACCEPT OR USE ALL OR ANY PORTION OF THE SERVICES INCLUDING SUPPORT TRAINING COURSES OR PROFESSIONAL SERVICES YOU WILL Decline Figure 2 2 Sonatype CLM Server End User License Agreement Window After a success message you will be redirected to the Product License page which will now display the expiry date of the license as visible in Figure 2 3 Product License Uninstall License Expires September 27 2020 Figure 2 3 Ins
8. n configuration file for the CLM server installation is a YML formatted file called config yml found in the installation directory CLM server is an application running on a Dropwizard server In addition a number of configuration steps can be taken within the running server user interface This section will discuss various configuration options in the config file as well as some other configura tion scenarios When editing the file it is important to preserve the indentations since they are significant for the resulting values created when parsing the configuration file Generic configuration information can be found in the Dropwizard User Manual Tip The config yml format does not support tab characters Use an editor that displays special charac ters like tabs when editing the file 3 1 Initial Configuration of CLM Server Beside the license installation mentioned earlier there are a few further configuration steps you should consider before diving right into using the CLM server You can configure various aspects in the CLM Step 1 Install and Configure 12 System Preferences section of the CLM server user interface which you can access by clicking on the System Preferences icon o located in the top right of the CLM Header Screen resembles a cog gear and choose the desired option to configure e Configure Users and Global Roles in the Security section of the left hand navigation menu potentially combined with LDAP co
9. nfiguration available in the Configuration section Read more about the security setup outlined in the security documentation e Configure Proprietary Packages so that the CLM server can distinguish your own code from other unknown components Refer to the component match and identification documentation in the report user guide for more information e Inspect or update or configure your Product License 3 2 Running the CLM Server Behind a HTTP Proxy Server Many organizations filter control and optimize access to the internet via a proxy server Any server or even any computer within the organization is forced to connect to the internet via the proxy server The Sonatype CLM Server needs to communicate with the Sonatype CLM backend services hosted on the internet To allow the CLM server to connect via a proxy you have to specify the connection details in the proxy section of the config yml file displayed in Proxy Configuration in config yml Proxy Configuration in config yml proxy hositename o OO AS Port 80 username anonymous password guest If your proxy server is based on whitelisted URLs you can use the following list of URLs to ensure that the CLM server can reach all the required services e https clm sonatype com e http cdn sonatype com Step 1 Install and Configure 13 3 3 Setting the Base URL If your CLM server is accessed via a https proxy or a proxy server that changes the http port or fo
10. onfigure Return to the Nine Steps Main Page Step 1 Install and Configure 1 Chapter 1 Introduction Welcome to Step 1 where it all begins This guide is straightforward and will walk you through everything you need to download install and configure the Sonatype CLM Server Step 1 Install and Configure 2 Chapter 2 Preparation and Installation 2 1 Hardware Prerequisites and Recommendations Sonatype CLM Server is typically deployed on a dedicated server More specific hardware requirements are ultimately a function of the deployment architecture the primary usage patterns and the scale of deployment With these influencing factors in mind we recommend a modern processor speed with at least 8 CPU cores and 8GB of physical RAM for initial setup A minimum of 6GB of process space should be available to the CLM server Additional RAM can improve the performance due to decreased disk caching As an example a Sonatype CLM Server deployment at Sonatype is using a Dual Intel Xeon E5620 with 2 4Ghz 12M Cache 5 86 GT s QPI Turbo HT Storage requirements range with the number of applications projected to use the CLM server For less than 1000 applications 200GB is recommended Between 1000 and 2000 applications we suggest to use 500GB Above 2000 applications we suggest to provide 1 TB of storage Tip Monitoring disk space usage will help you gauge the storage needs in your actual deployment and react to growing
11. onfigure 15 HTTP Configuration in config yml EE Powe cO70 adminport 8071 3 8 HTTPS SSL One option to expose the CLM server via https is to use an external server like Apache httpd or nginx and configure it for reverse proxying the external connections via https to internal http connection This reverse proxy can be installed on the same server as the Sonatype CLM server or a different server and numerous tutorials for this setup are available on the internet A second option is to directly configure SSL support for Dropwizard by modifying the http segment in the config yml file following the example in HTTPS Configuration in config yml HTTPS Configuration in config yml http port 8443 adminport 8471 connectorType nonblocking ssl ssl keyStore path to your keystore file keyStorePassword yourpassword The keystore file can be generated and managed with the keytool Further documentation is available in the Dropwizard documentation and the documentation for keytool Step 1 Install and Configure 16 Chapter 4 Conclusion Pat yourself on the back the heavy lifting is mostly over now you are ready to move on to the Step 2 Organizations and Applications
12. ons for events such as policy viola tions This functionality requires an SMTP server available to the CLM server To allow the CLM server to send emails you have to specify the connection details to the SMTP server in the mail section of the config yml file displayed in Mail Configuration in config yml Mail Configuration in config yml mail hostname your mailserver com port 465 username user company com password password tls true ssl true systemEmail SonatypeCLM localhost The connection details are established with hostname and port and optionally with the addition of username password tls and ssl The systemEmail parameter will be used as the sender email for any emails the CLM server sends 3 6 Logging Configuration The CLM server application logging can be configured in the Logging section of the config yml file By default a log directory is created in the installation directory and the clm server 1og is rotated Further logging configuration is documented in the Dropwizard manual 3 7 HTTP Configuration The HTTP configuration in config yml is displayed in HTTP Configuration in config yml The port parameter for the CLM server allows you to set the port at which the application is available The adminPort exposes the operational menu Both ports can be freely changed to other values as long as these port numbers are not used and in the allowed range of values greater than 1024 Step 1 Install and C
13. ops and potentially work better across different Unix flavours but shows the principal functionality A similar script can be used for Windows Simplistic Service Script for Unix Systems bin sh SONATYPE_CLM_SERVER_HOME opt tools sonatype clm server VERS KONS MORZ JAVA_OPTIONS Xmx1024m XX MaxPermSize 128m The user ID which should be used to run the CLM server Step 1 Install and Configure 9 IMPORTANT Make sure that the user has the required privileges to gt write into the CLM work directory RUN_AS_USER clm do_start cd SSONATYPE_CLM_SERVER_HOME su m SRUN_AS_USER c java Jar SJAVA_OPTIONS sonatype clm server SVERSION jar server config yml gt dev null 2 gt amp 1 echo Started Sonatype CLM Server do_console cd SONATYPE_CLM_SERVER_HOME java jar SJAVA_OPTIONS sonatype clm server SVERSION jar server config yml do_stop pid ps aux grep sonatype clm server grep v grep awk print 2 ame Ieatalal Souto echo Killed Sonatype CLM Server PAD Spade do_usage echo Usage clm console start stop case 1 in console do_console ad start do_start ad stop do_stop ri x do_usage ri esac Setting up this script as a startup script will vary between operating systems and distributions depending on the init system used Generally the script would
14. r other reasons can potentially not determine what the authoritative URL to access the server itself is you need to configure the baseUr1 parameter baseUrl http clm server example com It is used by the server for any user facing links e g located in email notifications sent by the server to direct users to the server 3 4 File Configuration Sonatype CLM Server stores various files and data related to its operations in a work directory By default this data is stored ina sonatype work clm server directory in the path the server runs The directory is configurable using the sonat ypeWork field in File Configuration in config yml File Configuration in config yml sonatypeWork sonatype work clm server In addition Sonatype CLM Server uses the system temporary directory during its operation This folder varies by operating system but is usually controlled by an environmental variable If a specific directory needs to be used the CLM Server can be started with a command line flag as such cd opt sonatype clm server java jar Djava io tmpdir path to tmpdir sonatype clm server 1 10 2 jar server config yml Note that the user account which the server runs under must have sufficient access rights to both the work and temporary directory in order for Sonatype CLM Server to function properly Step 1 Install and Configure 14 3 5 Email Configuration The Sonatype CLM Server can be configured to send email notificati
15. talled Product License on Sonatype CLM Server Step 1 Install and Configure 7 2 CLM Server Directories When the Sonatype CLM Server first starts it creates a directory for the storage of all its data and configu ration This directory is configured in config ym1 and defaults to sonatype work clm server This path is relative to the location from which the invoking java command is used Using the default startup command from the installation directory causes sonat ype work clm server to be created within it If you would like to separate the installation and data directories you can set the sonat ypeWork toa different location Additionally a 1og directory is created within the installation directory and the current LogFilename parameter in config ym1 can be used to change the location Further information on logging configu ration can be found in Section 3 6 2 8 Running CLM Server as a Service For production usage we strongly recommend to set up the CLM server as a service or daemon This will ensure that any operating system reboots will include starting up the CLM server A dedicated user for running a service is a well known best practice This users should have reduced access rights as compared to the root user Configuration of this user will depend on the operating system and security system used Once the user is configured you need to ensure that full access rights to the CLM server installation directory are
Download Pdf Manuals
Related Search