diff --git a/Catalyst/source/confSettings.rst b/Catalyst/source/confSettings.rst new file mode 100644 index 0000000..70f0ab8 --- /dev/null +++ b/Catalyst/source/confSettings.rst @@ -0,0 +1,23 @@ + + + + + +Config Setup +^^^^^^^^^^^^ + +In Config Setup we will cover Chef Server and Puppet Server: + +The Chef server is the highly scalable foundation of the Chef automation platform. Create a flexible, dynamic infrastructure across multiple datacenters, public and private clouds, and in heterogeneous environments. + +Puppet master is a Ruby application that compiles configurations for any number of Puppet agent nodes, using Puppet code and various other data sources. (For more info, see Overview of Puppet's Architecture.) + + +.. toctree:: + :maxdepth: 2 + + confsetupdefined + + + + diff --git a/Catalyst/source/configmanagement.rst b/Catalyst/source/configmanagement.rst index c4cb50c..6e626d3 100644 --- a/Catalyst/source/configmanagement.rst +++ b/Catalyst/source/configmanagement.rst @@ -1,69 +1,6 @@ -Puppet Server -^^^^^^^^^^^^^ - -Puppet Server is an application that runs on the Java Virtual Machine (JVM) and provides the same services as the classic Puppet master application. It mostly does this by running the existing Puppet master code in several JRuby interpreters, but it replaces some parts of the classic application with new services written in Clojure. - -If you are using Puppet for your configuration management requirements, configure it in RLCatalyst. You can configure only one puppet server for one organization. Same puppet server cannot be associated with multiple organizations. - -To configure a new puppet server follow the steps below: - - * From the main menu click on Settings - * Once you click on Settings, from the side menu click on Devops Setup - * Click on Puppet Server - * Click on New button provided - * Enter the puppet server name in the Name box - * Enter the user name in User Nane field - * Enter the Hostname in Host Name field - * Choose the organization from the Organization drop down list - * Choose the Authentication by selecting Password / Pem file - * Enter Password / Upload the pem file - - .. image:: /images/createPuppet.JPG - - - * Click on Save button - * Now your Puppet server is configured and listed in the Puppet Server Management page - - .. image:: /images/puppetList.JPG - -***** - -**Import nodes from Puppet Server** - -You can import existing nodes from the configured puppet server into RLCatalyst by selecting the required Business Group and Project. These imported nodes can be operated from the Workzone. - - * To import the existing nodes click on Import button - * Select the node and the respective Environment for the dropdown - * Select the environment from Environment drop down list for the node to be imported - * Select the respective checkbox in the Action column - * Click on the Import Nodes button - * Select the business group from Business Group drop down list - * Select the project from the Project drop down list - * Enter the user name to access server for import in the User Name box - * Choose authentication type from the Choose Authentication Type drop down list. RLCatalyst provide two types of authentication, you can either choose Password or by uploading the PEM file - * Type Password or upload PEM file - * Click on Import button - * Close the popup containing the success message 'Node imported' - * The imported node will be available in the respective Environment of the Workzone - - - **Note**: For the imported node using puppet server , Puppet client run icon will be shown. - -**Hereby attaching a video which will demonstrate as in how to Create Puppet in RLCatalyst:** - - -.. raw:: html - - -
- -
- -***** - .. _configure-nexus: Nexus Server @@ -86,14 +23,14 @@ To configure a new Nexus server follow the steps below: * Choose the organization from the Organization drop down list * Click on + icon present next to Nexus Group ID Details and enter valid Nexus GroupID and save - .. image:: /images/nexusDetails.png + .. image:: /images/updated_img/nexusDetails.png * Click on Save button * Now the Nexus server setup is ready and listed in the Nexus Server page - .. image:: /images/nexusList.JPG + .. image:: /images/updated_img/nexusList.png **Hereby attaching a video which will demonstrate as in how to Create Nexus in RLCatalyst:** @@ -128,8 +65,8 @@ Once Nexus Server is configured you have to associate Repository details to your * Click on Save button on Edit Project Page -Configure Docker -^^^^^^^^^^^^^^^^ +Docker +^^^^^^ Docker is all about making it easier to create, deploy, and run applications by using containers. Containers allow a developer to package up an application with all of the parts it needs, such as libraries and other dependencies, and ship it all out as one package. @@ -146,7 +83,7 @@ You can configure the Docker setup with RLCatalyst. To configure the Docker setu * Provide the email address to connect to the Docker in the Email Id field * Enter the Docker password in the Password field - .. image:: /images/createDocker.JPG + .. image:: /images/updated_img/createDocker.png * Click Save button * Now Docker is successfully configured to RL Catalyst @@ -167,8 +104,8 @@ You can configure the Docker setup with RLCatalyst. To configure the Docker setu .. _Configure-Jenkins: -Configure Jenkins -^^^^^^^^^^^^^^^^^ +Jenkins +^^^^^^^ Jenkins is CI/CD tool which can be used for build and deployment automation. You can configure the Jenkins setup with RLCatalyst.To configure the Jenkins setup follow the steps below: @@ -182,7 +119,7 @@ Jenkins is CI/CD tool which can be used for build and deployment automation. You * Enter the user ID in the User ID field * Enter the Jenkins password in the Password field - .. image:: /images/createJenkins.JPG + .. image:: /images/updated_img/createJenkins.png * Click Save button * Now Jenkins is successfully configured to RLCatalyst @@ -204,8 +141,8 @@ Jenkins is CI/CD tool which can be used for build and deployment automation. You .. _provider-settings: -Providers in RLCatalyst -^^^^^^^^^^^^^^^^^^^^^^^^ +Providers +^^^^^^^^^ RLCatalyst supports infra automation across providers like AWS, Azure, VMware, Openstack. Each provider needs to be configured with the proper credentials amd other required details before it can be used. @@ -237,15 +174,16 @@ To choose this mode, unselect the checkbox **Requires Access Credentials** To choose this mode select the checkbox **Requires Access Credentials** - * Provide the access key in the Access Key field - * Provide the secret key in the Secret Key field - * Select the organization from the Organization drop down list - * Select the region from the Region drop down list where your provider is located - * Select the key pair for the provider from the Key Pair drop down list - * Upload the .pem file for Provider + * Provide the access key in the Access Key field + * Provide the secret key in the Secret Key field + * Provide the bucket name in the S3 Bucket Name field + * Select the organization from the Organization drop down list + * Select the region from the Region drop down list where your provider is located + * Select the key pair for the provider from the Key Pair drop down list + * Upload the .pem file for Provider - .. image:: /images/createProvider.PNG + .. image:: /images/updated_img/createProvider.png * Click on Save button @@ -314,63 +252,70 @@ To choose this mode select the checkbox **Requires Access Credentials** ***** -.. _provider-sync: -Provider Sync for AWS -^^^^^^^^^^^^^^^^^^^^^ -Provider sync allows you to import unmanaged instances to Catalyst. Once you import your node to catalyst appliaction it will bootstrap and will be displayed in Managed instances tab. +**Provider Sync for AWS** -**Managed Instance** means Node which has been bootstrapped by Catalyst and **Unmanaged instances** means Node which has not been bootstrapped by catalyst. +Provider sync allows you to import unmanaged instances to Catalyst. Follow the below steps for AWS provider sync: * Create an **AWS** provider as shown above. The Created provider will be available in Providers page - .. image:: /images/createAWS.jpg + .. image:: /images/updated_img/createAWS.png * Click on the Sync Instance button of the provider. + 1. Tags: you have two sections, left side you will get the tags which are present in ur AWS acccount will shown here and you can add description for your refrence only. And right side you can map the tags with PROJECT ans ENVIRONMENT, Specify which tags represent project name and the environment name. Once you will save it, you can see the refelection in Mapping tab. + + .. image:: /images/updated_img/providers.png + + + 2. Mappings: In Mapping, all the mapped Tag Values would be visible with respect to Projects and Environment. Select one tag name for project from drop down as well as Environment tag name for Environment And save the changes. Now go to Instances tab. + + .. image:: /images/updated_img/mapping.png -* Click on UnManaged instances tab - - .. image:: /images/unManagedIns.PNG -* Select the Instance with the Action to be imported - .. image:: /images/selectInstance.PNG + 3. Instances: You have 3 catalyst status: + * Managed: If catalyst status is ‘Managed’, you will get all “Bootstraped successfull Instances”. You can delete the instances from here. + * Assigned: If you want to assign some unassigned Instance then you have to update tags corresponding to the mapping. + * Unassigned: Here you will get all other Instances available in your AWS account. Here you can update the tags value by selecting the node. -* Click on Import Instances button + **Unassigned Instances**: - .. image:: /images/importIns.PNG + .. image:: /images/updated_img/unassignedInstances.png + **Assigned Instances**: -* A pop up is displayed with the message "Instance Imported" + .. image:: /images/updated_img/assignedInstance.png - .. image:: /images/instanceImported.PNG + **Managed Instances**: + .. image:: /images/updated_img/managedInstances.png.png -* Verify the Node is imported in the Environment - .. image:: /images/verfiyNode.PNG + 4. RDS: Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks. + **Unassigned RDS**: -* Click on Control panel -> Action History and Wait until the Bootstrap succeeds + .. image:: /images/updated_img/unassignedRDS.png - .. image:: /images/bootstrapSuccess.PNG + **Assigned RDS**: + .. image:: /images/updated_img/assignedRDS.png -Now click on Back to Instances Tab + 5. S3: A bucket is a logical unit of storage in Amazon Web Services (AWS) object storage service, Simple Storage Solution S3. Buckets are used to store objects, which consist of data and metadata that describes the data. + It is the account bucket name, where we store all the information regarding AWS Provider like instances cost and usage. -* Go to Settings -> Devops Setup -> Providers and click on Sync Instances button -The Bootstrapped node will be displayed under Managed Instances tab - .. image:: /images/managedInstances.PNG + .. image:: /images/updated_img/unassignedS3.png + .. image:: /images/updated_img/S3.png **Following video demonstrates how to do provider sync in RLCatalyst**: @@ -385,10 +330,22 @@ The Bootstrapped node will be displayed under Managed Instances tab ***** +CMDB +^^^^ +A configuration management database (CMDB) is a repository that acts as a data warehouse for information technology (IT) installations. It holds data relating to a collection of IT assets (commonly referred to as configuration items (CI)), as well as to descriptive relationships between such assets.To configure the CMDB setup follow the steps below: + * From the main menu click on Settings + * Once you click on Settings, from the side menu click on DevOps Setup + * Click on CMDB + * Click on New button provided + * Select the Organization to which the Jenkins server will be attached to + * Enter the name in the Name field + * Enter the Jenkins Server URL + * Enter the user ID in the User ID field + * Enter the Jenkins password in the Password field + .. image:: /images/updated_img/createJenkins.png - - - + * Click Save button + * Now Jenkins is successfully configured to RLCatalyst \ No newline at end of file diff --git a/Catalyst/source/confsetupdefined.rst b/Catalyst/source/confsetupdefined.rst new file mode 100644 index 0000000..c532fb4 --- /dev/null +++ b/Catalyst/source/confsetupdefined.rst @@ -0,0 +1,229 @@ + + + +.. _conf-settings: + + +Chef Server +^^^^^^^^^^^ +The Chef server acts as a hub for configuration data. The Chef server stores cookbooks, the policies that are applied to nodes, and metadata that describes each registered node that is being managed by the chef-client. + +A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef. + +A cookbook is the fundamental unit of configuration and policy distribution. + +A policy file allows you to specify in a single document the cookbook revisions and recipes that should be applied by the chef-client. + + +RLCatalyst allows you to configure your own chef server. You can add either a hosted chef server or an on-premise installation of chefserver. If you dont have either of these, please create an account at https://getchef.opscode.com/signup . For more details on chef, please go to :doc:`Chef Setup ` . + +In RLCatalyst only one chef server can be configured for one organization. The same chef server cannot be associated to multiple organizations. Each chef server account will have a URL(Hosted/On-Premise), a User pem file, a Validator pem file and a knife file . You will get all these files when you create accounts in Chef. + +Data/File needed for adding a Chef Server account in RLCatalyst + + * Name : Alias or name of the chef server , to be identified in RLCatalyst + * User Name : User name of your chef server account + * URL : URL of the hosted or on-premise chef server + * User Pem File : User file to access your Chef Server account + * Knife.rb : Configuration file that you get while setting up the Chef server + * Validator Pem File : During the first chef-client run, this private key does not exist. Instead, the chef-client will attempt to use the private key assigned to the chef-validator, located in /etc/chef/validation.pem. + * Key File : It is used to encrypt the contents of the data bag item. + * Template File : The default bootstrap operation relies on an Internet connection to get the distribution to the target node. If a target node cannot access the Internet, then a custom template i.e, template file can be used to define a specific location for the distribution so that the target node may access it during the bootstrap operation. + +To configure a new chef server follow the steps below: + + * From the main menu click on Settings + * Once you click on Settings, from the side menu click on Config Setup + * Click on Chef Server + * Click on New button provided + * Enter the configuration name in the Name field + * Enter the Chef user name in User Name field + * Provide or specify the Chef URL for the server to be configured + * Choose the organization from the Organization drop down list + * Upload the user PEM file provided by the Chef Server in the User PEM File field + * Upload the validator PEM file provided by the Chef Server in the Validator PEM File field + * Upload the Knife.rb file provided by the Chef Server in the Knife.rb File field + * Upload the key file which is used for Databag + * Upload the Template file which is used to Bootstrap node + + + .. image:: /images/updated_img/createChefServer.png + +***** + + + * Click on Save button + * Now your chef server is configured successfully and listed in the Chef server management page. + + .. image:: /images/updated_img/chefServer.png + +***** + +**Edit and Remove Chef Server configuration** + You can edit and remove a chef server configuration. + + +To Edit the Chefserver + * Click on edit button to edit chef server configuration details + +To Remove the Chefserver + * Click on delete button to remove chef server configuration from the list + +**Following video demonstrates how to configure a chef server in RLCatalyst:** + + +.. raw:: html + + +
+ +
+ +***** + +**Import nodes from Chef Server** + +You can import existing nodes from the configured chef server into RLCatalyst by selecting the required Business Group and Project. These imported nodes can be operated from the Workzone. + + * To import the existing nodes click on import button + * Select the environment from Environment drop down list for the node to be imported . These are the environments available in your Chef account + * Select the respective checkbox in the Action column + + .. image:: /images/updated_img/chefImport.png + +***** + + * Click on the Import Nodes button + * Select the business group from Business Group drop down list + * Select the project from the Project drop down list + * Enter the user name to access the chef server for import in the User Name field + * Choose authentication type from the Choose Authentication Type drop down list. RLCatalyst provides two types of authentication, you can either choose Password or by uploading the PEM file + * Type Password or upload PEM file + * Click on Import button + * Close the popup containing the success message 'Node imported' + * Click on Workzone + * The imported node will be available in the respective Environment of the Workzone + +***** + +**Chef Factory** + It consists of common and re-usable recipes and cookbooks. + + * Click on Chef factory icon present in the Action column , Chef factory page will open. + + .. image:: /images/updated_img/chefFactory.png + + * Go to Sync tab, here all the cookbooks and roles which are present in the chef server will be listed. + + .. image:: /images/updated_img/chefCookbooks.png + + * Select the Cookbook and click on Sync + * Close the popup window + * Go to Cookbooks tab, here you can find the downloaded (Synched) cookbook + + .. image:: /images/updated_img/chefFactoryActions.png + +***** + + +**Databags and Items for Chef server** + +A data bag is a global variable that is stored as JSON data and is accessible from a Chef server.A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. + +A data bag item may be encrypted using shared secret encryption. This allows each data bag item to store confidential information (such as a database password) or to be managed in a source control system (without plain-text data appearing in revision history). Each data bag item may be encrypted individually; if a data bag contains multiple encrypted data bag items, these data bag items are not required to share the same encryption keys. + + +How to create Databag and Items for Chef Server? + + * In the Chef Server Page, Click on Databag icon in the Action column of your chef server + * Click on + icon above the List of Data Bags column header + + .. image:: /images/updated_img/databag.png + +***** + + * Enter the name of the Databag in the Name field + + + .. image:: /images/updated_img/createDatabag.png + +***** + + * Click on Save button + * Select the Created Databag and create an item by clicking + icon above the 'Items for -Databagname' column header + * Enter the ID and Item body + + .. image:: /images/updated_img/createDatabagItem.png + +***** + + * Select the checkbox Do you want to Encrypt + * Click on Save button + * Now Databag and its item is created. Item body is shown in last column + * Click on Close button to navigate back to Chef server management page + +***** + + +Puppet Server +^^^^^^^^^^^^^ + +Puppet Server is an application that runs on the Java Virtual Machine (JVM) and provides the same services as the classic Puppet master application. It mostly does this by running the existing Puppet master code in several JRuby interpreters, but it replaces some parts of the classic application with new services written in Clojure. + +If you are using Puppet for your configuration management requirements, configure it in RLCatalyst. You can configure only one puppet server for one organization. Same puppet server cannot be associated with multiple organizations. + +To configure a new puppet server follow the steps below: + + * From the main menu click on Settings + * Once you click on Settings, from the side menu click on Config Setup + * Click on Puppet Server + * Click on New button provided + * Enter the puppet server name in the Name box + * Enter the user name in User Nane field + * Enter the Hostname in Host Name field + * Choose the organization from the Organization drop down list + * Choose the Authentication by selecting Password / Pem file + * Enter Password / Upload the pem file + + .. image:: /images/updated_img/createPuppet.png + + + * Click on Save button + * Now your Puppet server is configured and listed in the Puppet Server Management page + + .. image:: /images/updated_img/puppetList.png + +***** + +**Import nodes from Puppet Server** + +You can import existing nodes from the configured puppet server into RLCatalyst by selecting the required Business Group and Project. These imported nodes can be operated from the Workzone. + + * To import the existing nodes click on Import button + * Select the node and the respective Environment for the dropdown + * Select the environment from Environment drop down list for the node to be imported + * Select the respective checkbox in the Action column + * Click on the Import Nodes button + * Select the business group from Business Group drop down list + * Select the project from the Project drop down list + * Enter the user name to access server for import in the User Name box + * Choose authentication type from the Choose Authentication Type drop down list. RLCatalyst provide two types of authentication, you can either choose Password or by uploading the PEM file + * Type Password or upload PEM file + * Click on Import button + * Close the popup containing the success message 'Node imported' + * The imported node will be available in the respective Environment of the Workzone + + + **Note**: For the imported node using puppet server , Puppet client run icon will be shown. + +**Hereby attaching a video which will demonstrate as in how to Create Puppet in RLCatalyst:** + + +.. raw:: html + + +
+ +
+ +***** \ No newline at end of file diff --git a/Catalyst/source/gallerySetup.rst b/Catalyst/source/gallerySetup.rst index 52cbacf..2f95ce6 100644 --- a/Catalyst/source/gallerySetup.rst +++ b/Catalyst/source/gallerySetup.rst @@ -8,18 +8,6 @@ Gallery Setup * Template Types: RL Catalyst supports the following template types **SoftwareStack**, **OSImage**, **CloudFormation**, **Docker**, **ARMTemplate**. You can create various templates using these template types. - **Software Stack:** Software Stack Template type allows you to create a blueprint with set of cookbooks that work sequentially to produce a result. - - **OSImage:** OSImage template type allows you to craete blueprint with the help of VMimages - - - **CloudFormation:** It simplifies provisioning and management on AWS. You can create templates which is in JSON format for the service or application architectures you want and have AWS CloudFormation use those templates for quick and reliable provisioning of the services or applications (called “stacks”). - - **Docker:** Docker provides an integrated technology suite that enables development and IT operations teams to build, ship, and run distributed applications anywhere. - - - **ARM Template:** An Azure ARM Template is a JSON file that captures the infrastructure requirements of your application. An Azure Template defines a number of related resources that are required by your application. When an Azure Template is deployed on Azure, Azure Resource Manager ensures that all resources are brought to the specified states so that your application runs under the exact desired environments. - * Templates: You can create different templates in RL Catalyst for all supported Cookbooks. You can also add new templates for newly added Cookbooks. To know more on what is a Cookbook please click: http://docs.chef.io/cookbooks.html * Service Command: Service command allows you to setup the service running options. You can choose between Chef Cookbooks based services or System service based commands. diff --git a/Catalyst/source/gallerydefined.rst b/Catalyst/source/gallerydefined.rst index 0dafe0d..b6f3c4c 100644 --- a/Catalyst/source/gallerydefined.rst +++ b/Catalyst/source/gallerydefined.rst @@ -4,6 +4,23 @@ .. _configure-softwarestack: +Template Types +^^^^^^^^^^^^^^ + +RL Catalyst supports the following template types **SoftwareStack**, **OSImage**, **CloudFormation**, **Docker**, **ARMTemplate**. You can create various templates using these template types. + + **Software Stack:** Software Stack Template type allows you to create a blueprint with set of cookbooks that work sequentially to produce a result. + + **OSImage:** OSImage template type allows you to craete blueprint with the help of VMimages + + + **CloudFormation:** It simplifies provisioning and management on AWS. You can create templates which is in JSON format for the service or application architectures you want and have AWS CloudFormation use those templates for quick and reliable provisioning of the services or applications (called “stacks”). + + **Docker:** Docker provides an integrated technology suite that enables development and IT operations teams to build, ship, and run distributed applications anywhere. + + + **ARM Template:** An Azure ARM Template is a JSON file that captures the infrastructure requirements of your application. An Azure Template defines a number of related resources that are required by your application. When an Azure Template is deployed on Azure, Azure Resource Manager ensures that all resources are brought to the specified states so that your application runs under the exact desired environments. + Templates ^^^^^^^^^ diff --git a/Catalyst/source/gettingimplemented.rst b/Catalyst/source/gettingimplemented.rst index d4ba849..6c1677a 100644 --- a/Catalyst/source/gettingimplemented.rst +++ b/Catalyst/source/gettingimplemented.rst @@ -359,9 +359,9 @@ We are deplying MyShopper application with deploy_iis cookbook. -.. _Launch New ubuntu Instance,Install Tomcat,upgrade to-v8.0[attribute]: +.. _Launch New ubuntu Instance, Install Tomcat, upgrade to-v8.0[attribute]: -Scenario 9 : Create a new Ubuntu Instance,Install Tomcat and upgrade to latest version +Scenario 9 : Create a new Ubuntu Instance, Install Tomcat and upgrade to latest version ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. Add Provider . Skip this step if Scenario6 is already executed @@ -427,9 +427,9 @@ Please refer to :ref:`providersync and-import` for more details. ***** -.. _AWS Cost,Usage-Dashboards: +.. _AWS Cost, Usage-Dashboards: -Scenario 11 : AWS Cost,Usage Dashboards +Scenario 11 : AWS Cost, Usage Dashboards ^^^^^^^^^^^^^^^^^^^^^^^^^ RLCatalyst provides you a consolidated dashboard for tracking your AWS infrastructure cost and usage . This helps you to identify un-used capacity and do better utilization. RLCatalyst summarizes this data for all the AWS provider accounts configured. @@ -625,10 +625,6 @@ Scenario 14 : Create and Launch an AWS CFT Blueprint for 2-node Petclinic * Now verify the petclinic application using **http://VM2 Ipaddress:8080/petclinic**. You will be able to access the application - - - - Following video demonstrates how to Create and Launch an AWS CFT Blueprint for 2-node Petclinic in RLCatalyst: @@ -681,8 +677,6 @@ Please refer to :ref:`import-byip` for more details * Now Enter the following command **mysql -u root -p** and enter the same **Root Password** which you provided while editing the cookbook attributes and verify MySql - - Following video demonstrates how to Launch New Ubuntu Instance and deploy LAMP[Linux, Apache, MySql, PHP] in RLCatalyst: @@ -700,10 +694,10 @@ Following video demonstrates how to Launch New Ubuntu Instance and deploy LAMP[L -.. _Create & Execute Jenkins Jobs from-RLCatalyst: +.. _Configure and Execute a Jenkins-Jobs: -Scenario 16 : Configure and Execute a Jenkins Jobs from RLCatalyst -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Scenario 16 : Configure and Execute a Jenkins Jobs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Execute your Jenkins job from rlcatalyst and see the history of each jobs. Jenkins server should be configured in rlcatalyst to initiate the job execution. Please refer to * :ref:`Configure-Jenkins` @@ -725,7 +719,9 @@ Please refer to ``Jenkins Task`` under :ref:`Orchestration-JenkinsTask` to **Cre .. _Deploy and Promote-a Java Application: Scenario 17 : Deploy and Promote a Java Application -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Here we are deploying and promoting petclinic app. 1. Import a ubuntu node or Launch a Blueprint. Wait until the Node Bootstrap successfully. @@ -769,6 +765,8 @@ Now, Promote Petclinic in other enviornment: Scenario 18 : Deploy a 3-tier application ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Here we are deploying petclinic app using petclinic database, petclinic application and loadbalancer. + 1. Create three Blueprints: * Create a ubuntu blueprint and add role **petclinic_db** for first blueprint. @@ -830,10 +828,10 @@ By clicking on **Syn Instances** button, you will get 3 tabs, Tags, Mappings and ***** -.. _Application Deployment During Instance Launch using-Nexus Server: +.. _Design and Launch-Application: -Scenario 20 : Design and Launch Application Stack -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Scenario 20 : Design and Launch Application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Design an entire app and launch instance with the app running. @@ -862,14 +860,12 @@ Design an entire app and launch instance with the app running. ***** -.. _Create Composite-Blueprint: - -Scenario 21 : Create Composite-Blueprint -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _Design and Launch 3-tier-Application: -The purpose of Composite Blueprint is to launch multi-tier application. +Scenario 21 : Design and Launch 3-tier Application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Here we are going to launch Petclinic Application. petclinic Data Base, petclinic App and petclinic web(load balancer). for this we need to create blueprint for each of **software stack** type. +Here we are going to launch Petclinic Application. petclinic Data Base, petclinic App and petclinic web(load balancer), for this we need to create blueprint for each of **software stack** type. 1. While creating blueprint for petclinic database add **petclinic_db** role. diff --git a/Catalyst/source/gettingstarted.rst b/Catalyst/source/gettingstarted.rst index 6352d87..30377c6 100644 --- a/Catalyst/source/gettingstarted.rst +++ b/Catalyst/source/gettingstarted.rst @@ -22,18 +22,17 @@ You can install RLCatalyst using the installer script :: chmod +x installer.sh ./installer.sh + **Install using Docker** Download the docker image from:: - https://hub.docker.com/r/relevancelab/opensc-catalyst/ + https://hub.docker.com/r/relevancelab/catalystbaseimagenew/ and run these commands:: - docker pull relevancelab/opensc-catalyst - docker run -d --name -p :3001 relevancelab/opensc-catalyst:3.0.5 - -****** + docker pull relevancelab/catalystbaseimagenew:3.3.1 + docker run -t -i -p 3001:3001 --name catalyst331 relevancelab/catalystbaseimagenew:3.3.1 /bin/bash **Quick install using Vagrant** @@ -56,7 +55,7 @@ RL Catalyst Installation on Vagrant without chef:: If you have an AWS account, you can bring up RLCatalyst using the public AMI available. The public image is currently available for US east(N.Virginia) region. This comes with some basic configurations required by RLCatalyst -1. From your EC2 dashboard, select N.California region . In the Images/AMI link, choose "Public Images" in the dropdown . Search for image with AMI ID ``ami-9883c3f8`` and AMI Name ``RLCatalyst3.2.0`` +1. From your EC2 dashboard, select N.California region . In the Images/AMI link, choose "Public Images" in the dropdown . Search for image with AMI ID ``ami-52f4b632`` and AMI Name ``RLCatalyst3.3.1`` 2. Select the image and hit Launch 3. On the "Instance Type" page ,choose the instance size as t2.medium or bigger . We recommend atleast 4 GB RAM 4. On the "Configure Instance Details" page, choose your preferred Network and Subnets. If you want to assign a public IP to RLCatalyst, then enable "Auto-assign Public IP" @@ -123,11 +122,11 @@ RLCatalyst comes with the flexibility to create blueprints to automate dynamic p * :ref:`Deploy Windows App on-IIS` -* :ref:`Launch New ubuntu Instance,Install Tomcat,upgrade to-v8.0[attribute]` +* :ref:`Launch New ubuntu Instance, Install Tomcat, upgrade to-v8.0[attribute]` * :ref:`Provider Sync and-Import Instances` -* :ref:`AWS Cost,Usage-Dashboards` +* :ref:`AWS Cost, Usage-Dashboards` * :ref:`Deploy Wordpress on multiple docker-container` @@ -150,7 +149,7 @@ Jenkins is CI/CD tool which can be used for build and deployment automation. It **How to Configure, Create, Execute Jenkins Jobs and View History in RLCatalyst ?** -* :ref:`Create & Execute Jenkins Jobs from-RLCatalyst` +* :ref:`Configure and Execute a Jenkins-Jobs` * :ref:`Deploy and Promote-a Java Application` @@ -158,17 +157,9 @@ Jenkins is CI/CD tool which can be used for build and deployment automation. It * :ref:`Update tags in-AWS` -* :ref:`Application Deployment During Instance Launch using-Nexus Server` +* :ref:`Design and Launch-Application` -* :ref:`Create Composite-Blueprint` +* :ref:`Design and Launch 3-tier-Application` ***** - - - - - - - - diff --git a/Catalyst/source/images/AT1.png b/Catalyst/source/images/AT1.png deleted file mode 100644 index 9d0aaa3..0000000 Binary files a/Catalyst/source/images/AT1.png and /dev/null differ diff --git a/Catalyst/source/images/AT2.png b/Catalyst/source/images/AT2.png deleted file mode 100644 index 9891ff9..0000000 Binary files a/Catalyst/source/images/AT2.png and /dev/null differ diff --git a/Catalyst/source/images/AT3.png b/Catalyst/source/images/AT3.png deleted file mode 100644 index b699f25..0000000 Binary files a/Catalyst/source/images/AT3.png and /dev/null differ diff --git a/Catalyst/source/images/AT4.png b/Catalyst/source/images/AT4.png deleted file mode 100644 index 6ed311b..0000000 Binary files a/Catalyst/source/images/AT4.png and /dev/null differ diff --git a/Catalyst/source/images/AT5.png b/Catalyst/source/images/AT5.png deleted file mode 100644 index 4e1b210..0000000 Binary files a/Catalyst/source/images/AT5.png and /dev/null differ diff --git a/Catalyst/source/images/SG1.png b/Catalyst/source/images/SG1.png deleted file mode 100644 index a48a3e9..0000000 Binary files a/Catalyst/source/images/SG1.png and /dev/null differ diff --git a/Catalyst/source/images/SG2.png b/Catalyst/source/images/SG2.png deleted file mode 100644 index d338357..0000000 Binary files a/Catalyst/source/images/SG2.png and /dev/null differ diff --git a/Catalyst/source/images/SG3.png b/Catalyst/source/images/SG3.png deleted file mode 100644 index eb6f479..0000000 Binary files a/Catalyst/source/images/SG3.png and /dev/null differ diff --git a/Catalyst/source/images/SG4.png b/Catalyst/source/images/SG4.png deleted file mode 100644 index cbb0509..0000000 Binary files a/Catalyst/source/images/SG4.png and /dev/null differ diff --git a/Catalyst/source/images/SG5.png b/Catalyst/source/images/SG5.png deleted file mode 100644 index 74df18d..0000000 Binary files a/Catalyst/source/images/SG5.png and /dev/null differ diff --git a/Catalyst/source/images/SG6.png b/Catalyst/source/images/SG6.png deleted file mode 100644 index 89d418d..0000000 Binary files a/Catalyst/source/images/SG6.png and /dev/null differ diff --git a/Catalyst/source/images/updated_img/BG.png b/Catalyst/source/images/updated_img/BG.png new file mode 100644 index 0000000..c8304e7 Binary files /dev/null and b/Catalyst/source/images/updated_img/BG.png differ diff --git a/Catalyst/source/images/updated_img/RDS.png b/Catalyst/source/images/updated_img/RDS.png new file mode 100644 index 0000000..9004d51 Binary files /dev/null and b/Catalyst/source/images/updated_img/RDS.png differ diff --git a/Catalyst/source/images/updated_img/S3.png b/Catalyst/source/images/updated_img/S3.png new file mode 100644 index 0000000..f6312a1 Binary files /dev/null and b/Catalyst/source/images/updated_img/S3.png differ diff --git a/Catalyst/source/images/updated_img/addNewEnv.png b/Catalyst/source/images/updated_img/addNewEnv.png new file mode 100644 index 0000000..0202595 Binary files /dev/null and b/Catalyst/source/images/updated_img/addNewEnv.png differ diff --git a/Catalyst/source/images/updated_img/assignedInstance.png b/Catalyst/source/images/updated_img/assignedInstance.png new file mode 100644 index 0000000..d64244a Binary files /dev/null and b/Catalyst/source/images/updated_img/assignedInstance.png differ diff --git a/Catalyst/source/images/updated_img/assignedRDS.png b/Catalyst/source/images/updated_img/assignedRDS.png new file mode 100644 index 0000000..e9682d7 Binary files /dev/null and b/Catalyst/source/images/updated_img/assignedRDS.png differ diff --git a/Catalyst/source/images/updated_img/chefFactory.png b/Catalyst/source/images/updated_img/chefFactory.png new file mode 100644 index 0000000..3f917ff Binary files /dev/null and b/Catalyst/source/images/updated_img/chefFactory.png differ diff --git a/Catalyst/source/images/updated_img/chefFactoryActions.png b/Catalyst/source/images/updated_img/chefFactoryActions.png new file mode 100644 index 0000000..dad62c6 Binary files /dev/null and b/Catalyst/source/images/updated_img/chefFactoryActions.png differ diff --git a/Catalyst/source/images/updated_img/chefImport.png b/Catalyst/source/images/updated_img/chefImport.png new file mode 100644 index 0000000..d46a7f2 Binary files /dev/null and b/Catalyst/source/images/updated_img/chefImport.png differ diff --git a/Catalyst/source/images/updated_img/chefServer.png b/Catalyst/source/images/updated_img/chefServer.png new file mode 100644 index 0000000..e128d55 Binary files /dev/null and b/Catalyst/source/images/updated_img/chefServer.png differ diff --git a/Catalyst/source/images/updated_img/createAWS.png b/Catalyst/source/images/updated_img/createAWS.png new file mode 100644 index 0000000..30041b3 Binary files /dev/null and b/Catalyst/source/images/updated_img/createAWS.png differ diff --git a/Catalyst/source/images/updated_img/createChefServer.png b/Catalyst/source/images/updated_img/createChefServer.png new file mode 100644 index 0000000..228f048 Binary files /dev/null and b/Catalyst/source/images/updated_img/createChefServer.png differ diff --git a/Catalyst/source/images/updated_img/createDatabag.png b/Catalyst/source/images/updated_img/createDatabag.png new file mode 100644 index 0000000..1735dec Binary files /dev/null and b/Catalyst/source/images/updated_img/createDatabag.png differ diff --git a/Catalyst/source/images/updated_img/createDatabagItem.png b/Catalyst/source/images/updated_img/createDatabagItem.png new file mode 100644 index 0000000..4d659a4 Binary files /dev/null and b/Catalyst/source/images/updated_img/createDatabagItem.png differ diff --git a/Catalyst/source/images/updated_img/createDocker.png b/Catalyst/source/images/updated_img/createDocker.png new file mode 100644 index 0000000..1519ddc Binary files /dev/null and b/Catalyst/source/images/updated_img/createDocker.png differ diff --git a/Catalyst/source/images/updated_img/createEnv.png b/Catalyst/source/images/updated_img/createEnv.png new file mode 100644 index 0000000..810a2a5 Binary files /dev/null and b/Catalyst/source/images/updated_img/createEnv.png differ diff --git a/Catalyst/source/images/updated_img/createJenkins.png b/Catalyst/source/images/updated_img/createJenkins.png new file mode 100644 index 0000000..72da849 Binary files /dev/null and b/Catalyst/source/images/updated_img/createJenkins.png differ diff --git a/Catalyst/source/images/updated_img/createOrg.png b/Catalyst/source/images/updated_img/createOrg.png new file mode 100644 index 0000000..02fc70f Binary files /dev/null and b/Catalyst/source/images/updated_img/createOrg.png differ diff --git a/Catalyst/source/images/updated_img/createProject.png b/Catalyst/source/images/updated_img/createProject.png new file mode 100644 index 0000000..c1e4258 Binary files /dev/null and b/Catalyst/source/images/updated_img/createProject.png differ diff --git a/Catalyst/source/images/updated_img/createProvider.png b/Catalyst/source/images/updated_img/createProvider.png new file mode 100644 index 0000000..1d0a539 Binary files /dev/null and b/Catalyst/source/images/updated_img/createProvider.png differ diff --git a/Catalyst/source/images/updated_img/createPuppet.png b/Catalyst/source/images/updated_img/createPuppet.png new file mode 100644 index 0000000..ddb633e Binary files /dev/null and b/Catalyst/source/images/updated_img/createPuppet.png differ diff --git a/Catalyst/source/images/updated_img/createTeam.png b/Catalyst/source/images/updated_img/createTeam.png new file mode 100644 index 0000000..52928b4 Binary files /dev/null and b/Catalyst/source/images/updated_img/createTeam.png differ diff --git a/Catalyst/source/images/updated_img/createUser.png b/Catalyst/source/images/updated_img/createUser.png new file mode 100644 index 0000000..3aed5ee Binary files /dev/null and b/Catalyst/source/images/updated_img/createUser.png differ diff --git a/Catalyst/source/images/updated_img/databag.png b/Catalyst/source/images/updated_img/databag.png new file mode 100644 index 0000000..789c98a Binary files /dev/null and b/Catalyst/source/images/updated_img/databag.png differ diff --git a/Catalyst/source/images/updated_img/editBG.png b/Catalyst/source/images/updated_img/editBG.png new file mode 100644 index 0000000..b8a03bc Binary files /dev/null and b/Catalyst/source/images/updated_img/editBG.png differ diff --git a/Catalyst/source/images/updated_img/editOrg.png b/Catalyst/source/images/updated_img/editOrg.png new file mode 100644 index 0000000..40e2681 Binary files /dev/null and b/Catalyst/source/images/updated_img/editOrg.png differ diff --git a/Catalyst/source/images/updated_img/env.png b/Catalyst/source/images/updated_img/env.png new file mode 100644 index 0000000..b583c72 Binary files /dev/null and b/Catalyst/source/images/updated_img/env.png differ diff --git a/Catalyst/source/images/updated_img/managedInstances.png b/Catalyst/source/images/updated_img/managedInstances.png new file mode 100644 index 0000000..2c2c059 Binary files /dev/null and b/Catalyst/source/images/updated_img/managedInstances.png differ diff --git a/Catalyst/source/images/updated_img/mapping.png b/Catalyst/source/images/updated_img/mapping.png new file mode 100644 index 0000000..631a98a Binary files /dev/null and b/Catalyst/source/images/updated_img/mapping.png differ diff --git a/Catalyst/source/images/updated_img/nexusDetails.png b/Catalyst/source/images/updated_img/nexusDetails.png new file mode 100644 index 0000000..43b50e9 Binary files /dev/null and b/Catalyst/source/images/updated_img/nexusDetails.png differ diff --git a/Catalyst/source/images/updated_img/nexusList.png b/Catalyst/source/images/updated_img/nexusList.png new file mode 100644 index 0000000..8929617 Binary files /dev/null and b/Catalyst/source/images/updated_img/nexusList.png differ diff --git a/Catalyst/source/images/updated_img/org.png b/Catalyst/source/images/updated_img/org.png new file mode 100644 index 0000000..3767176 Binary files /dev/null and b/Catalyst/source/images/updated_img/org.png differ diff --git a/Catalyst/source/images/updated_img/project.png b/Catalyst/source/images/updated_img/project.png new file mode 100644 index 0000000..73173f6 Binary files /dev/null and b/Catalyst/source/images/updated_img/project.png differ diff --git a/Catalyst/source/images/updated_img/providers.png b/Catalyst/source/images/updated_img/providers.png new file mode 100644 index 0000000..ddd1288 Binary files /dev/null and b/Catalyst/source/images/updated_img/providers.png differ diff --git a/Catalyst/source/images/updated_img/puppetList.png b/Catalyst/source/images/updated_img/puppetList.png new file mode 100644 index 0000000..52c82f0 Binary files /dev/null and b/Catalyst/source/images/updated_img/puppetList.png differ diff --git a/Catalyst/source/images/updated_img/roles.png b/Catalyst/source/images/updated_img/roles.png new file mode 100644 index 0000000..921e14c Binary files /dev/null and b/Catalyst/source/images/updated_img/roles.png differ diff --git a/Catalyst/source/images/updated_img/tagsInstance.png b/Catalyst/source/images/updated_img/tagsInstance.png new file mode 100644 index 0000000..85afd6c Binary files /dev/null and b/Catalyst/source/images/updated_img/tagsInstance.png differ diff --git a/Catalyst/source/images/updated_img/unassignedInstances.png b/Catalyst/source/images/updated_img/unassignedInstances.png new file mode 100644 index 0000000..544bb8a Binary files /dev/null and b/Catalyst/source/images/updated_img/unassignedInstances.png differ diff --git a/Catalyst/source/images/updated_img/unassignedRDS.png b/Catalyst/source/images/updated_img/unassignedRDS.png new file mode 100644 index 0000000..64b3416 Binary files /dev/null and b/Catalyst/source/images/updated_img/unassignedRDS.png differ diff --git a/Catalyst/source/images/updated_img/unassignedS3.png b/Catalyst/source/images/updated_img/unassignedS3.png new file mode 100644 index 0000000..4943282 Binary files /dev/null and b/Catalyst/source/images/updated_img/unassignedS3.png differ diff --git a/Catalyst/source/orgSettings.rst b/Catalyst/source/orgSettings.rst index 7446b0f..539515a 100644 --- a/Catalyst/source/orgSettings.rst +++ b/Catalyst/source/orgSettings.rst @@ -6,7 +6,7 @@ Organization Setup ^^^^^^^^^^^^^^^^^^ -To start using RL Catalyst, the first step is to setup an organization. While you setup an organization in RLCatalyst, you should also set up the Business Groups and Projects under the organization . An Organization can be an enterprise or a business that can have multiple sub groups and projects . An organization can have multiple Business Groups and each Business Group can have multiple Projects +To start using RL Catalyst, the first step is to setup an organization. While you setup an organization in RLCatalyst, you should also set up the Business Groups and Projects under the organization. An Organization can be an enterprise or a business that can have multiple sub groups and projects. An organization can have multiple Business Groups and each Business Group can have multiple Projects .. toctree:: diff --git a/Catalyst/source/orgsetupdefined.rst b/Catalyst/source/orgsetupdefined.rst index f6341c4..e9a1ec7 100644 --- a/Catalyst/source/orgsetupdefined.rst +++ b/Catalyst/source/orgsetupdefined.rst @@ -17,13 +17,13 @@ An Organization can be an enterprise or a business that can have multiple sub gr * Click on New button provided * In Create Organization page enter Name (Organization Name) and Domain Name (Website Address) - .. image:: /images/createOrg.JPG + .. image:: /images/updated_img/createOrg.png * Click on Save button * Now your Organization is setup and listed in the Organizations page - .. image:: /images/orgList.JPG + .. image:: /images/updated_img/org.png @@ -41,7 +41,7 @@ To Remove the Organization You can activate or inactivate an Organization by using the cursor button provided. Remember, once you inactivate the organization all the entities relating to that organization will be disabled. You can enable the organization at any time. which will activate all the entities associated with that organization - .. image:: /images/editOrg.png + .. image:: /images/updated_img/editOrg.png .. _bu-settings: @@ -62,12 +62,12 @@ In an Organization you can create multiple Business Groups. A Business Groups ca * Select the Organization from the Organization drop down list * Click on Save button - .. image:: /images/createBG.JPG + .. image:: /images/updated_img/editBG.png * Now the Business Group is setup and listed in the Business Groups page - .. image:: /images/businessList.JPG + .. image:: /images/updated_img/BG.png **Edit and Remove a Business Group** You can edit and remove a Business Group. @@ -102,11 +102,11 @@ In a Business Group you can create multiple Projects. A Project in RLCatalyst ca * Select the Business Group from the Business Group drop down list * Environments and repository details are not mandatory while creating project and will be explained in later section - .. image:: /images/createProj.JPG + .. image:: /images/updated_img/createProject.png * Click on Save button - .. image:: /images/projectList.JPG + .. image:: /images/updated_img/project.png **Edit and Remove a Project** You can edit and remove a Project. @@ -131,194 +131,32 @@ To Remove the Project -.. _chef-settings: - -Chef Server -^^^^^^^^^^^ -The Chef server acts as a hub for configuration data. The Chef server stores cookbooks, the policies that are applied to nodes, and metadata that describes each registered node that is being managed by the chef-client. - -A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef. - -A cookbook is the fundamental unit of configuration and policy distribution. - -A policy file allows you to specify in a single document the cookbook revisions and recipes that should be applied by the chef-client. - - -RLCatalyst allows you to configure your own chef server. You can add either a hosted chef server or an on-premise installation of chefserver. If you dont have either of these, please create an account at https://getchef.opscode.com/signup . For more details on chef, please go to :doc:`Chef Setup ` . - -In RLCatalyst only one chef server can be configured for one organization. The same chef server cannot be associated to multiple organizations. Each chef server account will have a URL(Hosted/On-Premise), a User pem file, a Validator pem file and a knife file . You will get all these files when you create accounts in Chef. - -Data/File needed for adding a Chef Server account in RLCatalyst - - * Name : Alias or name of the chef server , to be identified in RLCatalyst - * User Name : User name of your chef server account - * URL : URL of the hosted or on-premise chef server - * User Pem File : User file to access your Chef Server account - * Knife.rb : Configuration file that you get while setting up the Chef server - * Validator Pem File : During the first chef-client run, this private key does not exist. Instead, the chef-client will attempt to use the private key assigned to the chef-validator, located in /etc/chef/validation.pem. - * Key File : It is used to encrypt the contents of the data bag item. - * Template File : The default bootstrap operation relies on an Internet connection to get the distribution to the target node. If a target node cannot access the Internet, then a custom template i.e, template file can be used to define a specific location for the distribution so that the target node may access it during the bootstrap operation. - -To configure a new chef server follow the steps below: - - * From the main menu click on Settings - * Once you click on Settings, from the side menu click on Devops Setup - * Click on Chef Server - * Click on New button provided - * Enter the configuration name in the Name field - * Enter the Chef user name in User Name field - * Provide or specify the Chef URL for the server to be configured - * Choose the organization from the Organization drop down list - * Upload the user PEM file provided by the Chef Server in the User PEM File field - * Upload the validator PEM file provided by the Chef Server in the Validator PEM File field - * Upload the Knife.rb file provided by the Chef Server in the Knife.rb File field - * Upload the key file which is used for Databag - * Upload the Template file which is used to Bootstrap node - - - .. image:: /images/createChefServer.JPG - -***** - - - * Click on Save button - * Now your chef server is configured successfully and listed in the Chef server management page. - - .. image:: /images/Chefserverlist.JPG - -***** - -**Edit and Remove Chef Server configuration** - You can edit and remove a chef server configuration. - - -To Edit the Chefserver - * Click on edit button to edit chef server configuration details - -To Remove the Chefserver - * Click on delete button to remove chef server configuration from the list - -**Following video demonstrates how to configure a chef server in RLCatalyst:** - - -.. raw:: html - - -
- -
- -***** - -**Import nodes from Chef Server** - -You can import existing nodes from the configured chef server into RLCatalyst by selecting the required Business Group and Project. These imported nodes can be operated from the Workzone. - - * To import the existing nodes click on import button - * Select the environment from Environment drop down list for the node to be imported . These are the environments available in your Chef account - * Select the respective checkbox in the Action column - - .. image:: /images/chefImport.JPG - -***** - - * Click on the Import Nodes button - * Select the business group from Business Group drop down list - * Select the project from the Project drop down list - * Enter the user name to access the chef server for import in the User Name field - * Choose authentication type from the Choose Authentication Type drop down list. RLCatalyst provides two types of authentication, you can either choose Password or by uploading the PEM file - * Type Password or upload PEM file - * Click on Import button - * Close the popup containing the success message 'Node imported' - * Click on Workzone - * The imported node will be available in the respective Environment of the Workzone - -***** - -**Chef Factory** - It consists of common and re-usable recipes and cookbooks. - - * Click on Chef factory icon present in the Action column , Chef factory page will open. - - .. image:: /images/chefFactory.JPG - - * Go to Sync tab, here all the cookbooks and roles which are present in the chef server will be listed. - - .. image:: /images/chefCookbooks.JPG - - * Select the Cookbook and click on Sync - * Close the popup window - * Go to Cookbooks tab, here you can find the downloaded (Synched) cookbook - - .. image:: /images/chefFactoryActions.JPG - -***** - - -**Databags and Items for Chef server** - -A data bag is a global variable that is stored as JSON data and is accessible from a Chef server.A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. - -A data bag item may be encrypted using shared secret encryption. This allows each data bag item to store confidential information (such as a database password) or to be managed in a source control system (without plain-text data appearing in revision history). Each data bag item may be encrypted individually; if a data bag contains multiple encrypted data bag items, these data bag items are not required to share the same encryption keys. - - -How to create Databag and Items for Chef Server? - - * In the Chef Server Page, Click on Databag icon in the Action column of your chef server - * Click on + icon above the List of Data Bags column header - - .. image:: /images/databag.JPG - -***** - - * Enter the name of the Databag in the Name field - - - .. image:: /images/createDatabag.JPG - -***** - - * Click on Save button - * Select the Created Databag and create an item by clicking + icon above the 'Items for -Databagname' column header - * Enter the ID and Item body - - .. image:: /images/createDatabagItem.JPG - -***** - - * Select the checkbox Do you want to Encrypt - * Click on Save button - * Now Databag and its item is created. Item body is shown in last column - * Click on Close button to navigate back to Chef server management page - -***** - .. _env-settings: -Setup Environments -^^^^^^^^^^^^^^^^^^ +Environments +^^^^^^^^^^^^ In an Organization you can create multiple Environments. These environments need to be linked to Projects back. For example: Production, Development, Testing and so on. Follow the steps to setup a new Environment in an Organization: * From the main menu click on Settings - * Once you click on Settings, from the side menu click on Devops Setup + * Once you click on Settings, from the side menu click on Organization Setup * Click on Environments * Click on New button provided * Select the Organization from the Organization drop down list * Select the server from the Chef Server drop down list - * You can see a list of environments in teh drop down. These are the environments defined in your chef server account. You can select one from this drop down list **OR** you can Add new Environments to chef server by clicking on **Add** link provided right above the select an Chef Environment drop down + * You can see a list of environments in the drop down. These are the environments defined in your chef server account. You can select one from this drop down list **OR** you can Add new Environments to chef server by clicking on **Add** link provided right above the select an Chef Environment drop down * Now Enter the Environment name to be created - .. image:: /images/addNewEnv.JPG + .. image:: /images/updated_img/addNewEnv.png ***** * Click on Add button * Now select the environment you added to the chef server from the Chef Environment drop down list - .. image:: /images/createEnv.JPG + .. image:: /images/updated_img/createEnv.png ***** @@ -326,7 +164,7 @@ Follow the steps to setup a new Environment in an Organization: * Click on Save button. * Now the environment is setup and listed in the Environments page - .. image:: /images/envList.JPG + .. image:: /images/updated_img/env.png ***** diff --git a/Catalyst/source/quickinstaller.rst b/Catalyst/source/quickinstaller.rst index 0a97297..5f990a0 100644 --- a/Catalyst/source/quickinstaller.rst +++ b/Catalyst/source/quickinstaller.rst @@ -13,26 +13,10 @@ RLCatalyst can be installed quickly using a chef-based installer. This installer You can install RLCatalyst using the installer script :: - wget https://github.com/RLOpenCatalyst/installer/blob/master/installer.sh + wget https://raw.githubusercontent.com/RLOpenCatalyst/installer/master/installer.sh chmod +x installer.sh ./installer.sh - -.. _install-docker: -Install using Docker -==================== - -Download the docker image from:: - - https://hub.docker.com/r/relevancelab/opensc-catalyst/ - -and run these commands:: - - docker pull relevancelab/opensc-catalyst - docker run -d --name -p :3001 relevancelab/opensc-catalyst:3.0.5 - - - .. _install-vagrant: Install using Vagrant ===================== @@ -70,7 +54,7 @@ Install from AWS AMI If you have an AWS account, you can bring up RLCatalyst using the public AMI available. The public image is currently available for US east(N.Virginia) region. This comes with some basic configurations required by RLCatalyst -1. From your EC2 dashboard, select N.California region . In the Images/AMI link, choose "Public Images" in the dropdown . Search for image with AMI ID ``ami-9883c3f8`` and AMI Name ``RLCatalyst3.2.0`` +1. From your EC2 dashboard, select N.California region . In the Images/AMI link, choose "Public Images" in the dropdown . Search for image with AMI ID ``ami-52f4b632`` and AMI Name ``RLCatalyst3.3.1`` 2. Select the image and hit Launch 3. On the "Instance Type" page ,choose the instance size as t2.medium or bigger . We recommend atleast 4 GB RAM 4. On the "Configure Instance Details" page, choose your preferred Network and Subnets. If you want to assign a public IP to RLCatalyst, then enable "Auto-assign Public IP" diff --git a/Catalyst/source/settings.rst b/Catalyst/source/settings.rst index be17f74..511df30 100644 --- a/Catalyst/source/settings.rst +++ b/Catalyst/source/settings.rst @@ -4,7 +4,7 @@ Settings Add all your organization and asset details in Settings before using RLCatalyst. You can use the system only if you provide all the relevant options provided in the Settings. -Settings provides you six different options: +Settings provides you seven different options: .. _org-setup: @@ -13,6 +13,13 @@ Settings provides you six different options: orgSettings +.. _conf-setup: + +.. toctree:: + :maxdepth: 2 + + confSettings + .. _devops-setup: .. toctree:: diff --git a/Catalyst/source/userdefined.rst b/Catalyst/source/userdefined.rst index 0a647bc..d905b94 100644 --- a/Catalyst/source/userdefined.rst +++ b/Catalyst/source/userdefined.rst @@ -4,8 +4,24 @@ .. _user-settings: -User Creation -^^^^^^^^^^^^^ +User Roles +^^^^^^^^^^ + +Below are the permission sets currently available for the user roles in Catalyst. + +RL Catalyst provides three types of user roles. + + 1. Admin : Top level user of RL Catalyst + 2. Consumer : Access rights on Design and Workzone with all permissions + 3. Designer : Access rights on Workzone with only Execute permission + + These roles cannot be modified or deleted at any point of time. + + .. image:: /images/updated_img/roles.png + + +Users +^^^^^ You can add, update and remove users in RL Catalyst. Follow the steps below to Add, Update and Remove users. @@ -22,7 +38,7 @@ How to add a new user? * Select the appropriate role (Admin / Designer / Consumer) * Select the team. - .. image:: /images/createUser.JPG + .. image:: /images/updated_img/createUser.png * Click on Save button * New user is created and is availabe in Users page @@ -60,7 +76,7 @@ How to add a Team? * Assign the projects to the team by using the button provided in the Assign Projects section * New Team is created - .. image:: /images/createTeam.JPG + .. image:: /images/updated_img/createTeam.png ***** diff --git a/Catalyst/source/usersSetup.rst b/Catalyst/source/usersSetup.rst index d60bd2c..bd9a881 100644 --- a/Catalyst/source/usersSetup.rst +++ b/Catalyst/source/usersSetup.rst @@ -1,19 +1,8 @@ .. _user-role: -User Setup +Users Setup ^^^^^^^^^^ -**About User Roles** - -Below are the permission sets currently available for the user roles in Catalyst. - -RL Catalyst provides three types of user roles. - - 1. Admin : Top level user of RL Catalyst - 2. Consumer : Access rights on Design and Workzone with all permissions - 3. Designer : Access rights on Workzone with only Execute permission - - These roles cannot be modified or deleted at any point of time. - +In Users Setup we can create a user with particular role and assign teams. .. _user-setup: