{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"3d2d8035-4c77-4a49-86a2-02668636e42f"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"65a821ab-7439-49bb-ae91-8574512b1d5a"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"What are Endpoints?","type":"text"}]},{"type":"paragraph","content":[{"text":"Endpoints are the FlexDeploy representation of a device or virtual machine where plugins can be executed. They hold connection and host details that allow FlexDeploy to connect to and perform commands on the server.","type":"text"}]},{"type":"paragraph","content":[{"text":"FlexDeploy utilizes an agent-less as well as agent-based (available since 6.5.0.3) architecture to connect to computers across private or public networks/clouds to execute build and deploy operations. This architecture uses a secured communication protocol (SSH) or HTTPS. If HTTPS protocol is desired then ","type":"text"},{"text":"agent installation","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340174192"}}]},{"text":" is necessary. SSH connectivity eliminates the need for installing and managing software(agent) on every build and deployment target.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Endpoint Requirements","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"System Requirements","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340183716"}}]},{"text":" for information about Endpoint Requirements.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Viewing Endpoints","type":"text"}]},{"type":"paragraph","content":[{"text":"To view the configured Endpoints, select ","type":"text"},{"text":"Topology","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" from the menu, and then choose the ","type":"text"},{"text":"Endpoints","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" tab. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":75.0},"content":[{"type":"media","attrs":{"width":1511,"id":"65fb766e-958a-472e-8b35-40e17b85f1fe","collection":"contentId-10340181971","type":"file","height":707}}]},{"type":"paragraph","content":[{"text":"If you want to search the Endpoint , by clicking on filter symbol on different columns like Active, Name, Address, Description, Updated By, Updated On .","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":75.0},"content":[{"type":"media","attrs":{"width":1498,"id":"f5f5e03a-b375-4438-8bb4-e6e14dc6aef5","collection":"contentId-10340181971","type":"file","height":701}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Creating and Editing Endpoints","type":"text"}]},{"type":"paragraph","content":[{"text":"See the following links for information on creating Endpoints. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"Endpoint Defaults","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340173356"}}]},{"text":" to setup default values for new Endpoints to save time.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creating an SSH Endpoint","type":"text","marks":[{"type":"textColor","attrs":{"color":"#993300"}},{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340181934"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creating a LocalHost Endpoint","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340181922"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creating an HTTPS Endpoint","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340174221"}}]},{"text":" ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Endpoint Tags","type":"text"}]},{"type":"paragraph","content":[{"text":"To add a ","type":"text"},{"text":"Tag ","type":"text","marks":[{"type":"strong"},{"type":"em"},{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340185899"}}]},{"text":"to the Endpoint , click on the three dots that we are seeing on right side of the particular endpoint row.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":75.0},"content":[{"type":"media","attrs":{"width":1517,"id":"cefa4b12-49e7-43ca-a592-abfa2e49144e","collection":"contentId-10340181971","type":"file","height":692}}]},{"type":"paragraph","content":[{"text":"After clicking on the Add Tag option, then you can see a list of already created tags , by clicking on a tag from the list of tags such tag will be assigned to selected Endpoint.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":75.0},"content":[{"type":"media","attrs":{"width":1523,"id":"c6bbae12-074a-400a-9ae4-4b762c72d608","collection":"contentId-10340181971","type":"file","height":674}}]},{"type":"paragraph","content":[{"text":"To Manage the Tags you can navigate to ","type":"text"},{"text":"Tags ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"from the ","type":"text"},{"text":"menu ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"and manage the Tags ","type":"text"},{"text":"Tags | Managing Tags","type":"text","marks":[{"type":"link","attrs":{"href":"https://flexagon.atlassian.net/wiki/spaces/FD65/pages/10125816027/Tags#Managing-Tags"}}]},{"text":" .","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Activating and Inactivating Endpoints","type":"text"}]},{"type":"paragraph","content":[{"text":"To inactivate an Endpoint","type":"text"},{"text":" click the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"Active","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"strong"},{"type":"em"}]},{"text":" link on the desired endpoint, and it will toggle to ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"Inactive","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"strong"},{"type":"em"}]},{"text":". This will hide that Endpoint after leaving the screen, until the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"Active","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"strong"},{"type":"em"}]},{"text":" checkbox is unchecked. To reactivate an Endpoint, click the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"Inactive","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"strong"},{"type":"em"}]},{"text":" link and it will toggle back to ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"Active","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"strong"},{"type":"em"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Endpoint Directory Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"FlexDeploy creates and manages the following directory structure on the endpoints. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note that the permissions on this folder structure is 755 and must not be made less restrictive. Also, this folder structure is mostly owned by Endpoint User or Run As User.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"plugins","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"The plugins directory holds each version of a plugin that has been executed on the Endpoint. There can be several different plugins loaded and several versions of a given plugin. FlexDeploy will automatically purge older plugin versions, and redistribute them if an older version is later activated.","type":"text"}]},{"type":"paragraph","content":[{"text":"scratch","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Internal directory which is used for file transfer and managing permissions. Applicable only when using \"Run As User\" on the endpoint to execute commands as another privileged user.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The scratch folder is only created when using \"Run as User\" for the endpoint. This folder is created and owned Endpoint user, whereby all other directories are owned by the Run As User. This is required to facilitate the upload/download of files which are performed using the endpoint user.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"security","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"The security directory holds information related to the SSH connection between the FlexDeploy server and the Endpoint server and is used for secure communications.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]}]},{"type":"paragraph","content":[{"text":"work","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"The work directory contains every invocation of a plugin operation that has occurred on the Endpoint. There is additional file structure under the work directory based on the execution project id and the current execution id of the given project.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///artifacts","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory where artifacts are stored so they can be transferred back to the FlexDeploy server and stored permanently in the artifact repository.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///internal","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory where all internal FlexDeploy scripts are stored to execute the plugin step.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///object-results","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory utilized by partial deployment plugins to transfer the deployment status of each file back to the FlexDeploy server.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///reports","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory to write any report files during Build, Pre-deploy, Test or Deploy operations. The Report file size can be controlled from the Administration → System Settings page. Files are returned to the FlexDeploy server and processed.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///scan-results","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory for security scanning plugins (e.g. OWSAP, SonarQube) to place the scan results to be returned to the FlexDeploy server and processed.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///temp","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory for plugin execution to checkout and manipulate data or files until moved to the artifacts directory for storage.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///test-results","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory for test plugins (e.g. Junit, Postman) to place the test results to be returned to the FlexDeploy server and processed.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///transfer","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory used to return file from a plugin execution and feed as input into another plugin operation. This directory is only used in very specific use cases.","type":"text"}]},{"type":"paragraph","content":[{"text":"work///backups","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Directory used to backup a file from a plugin execution and put it into the backups repository. ","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported