Page not found
+ + +The audits page lets a champagne admin user view audits of actions being taken by users in all of champagne.
+
The application errors page lets a champagne admin user view and resolve a list of application errors that have occurred in champagne.
+
To resolve a single error, find the row with the error to resolve and click the 3 vertical dots to open the action menu and select Resolve.
+To resolve all existing errors that are unresolved, click the button at the top right of the Application Errors card.
+To view more details about a specific error, then find the row with the error and click the 3 vertical dots to open the action menu and select View Details. This will open a dialog with more information including error causes and stack traces.
+ +The systems page lets a champagne admin user manage a list of deployable systems in champagne.
+
button at the bottom of the screenThe create new system dialog will appear
+
Enter the new system name (This is required)
+To delete a system, find the row with the system to be deleted and click the 3 vertical dots to open the action menu and select Remove. Note this will delete EVERYTHING related to that system.
+ +The users page lets a champagne user manage a list of users.
+
button at the bottom of the screenThe create new user dialog will appear
+
Enter the user's first name (This is required)
+To remove a user from champagne, find the user to be removed and click the 3 vertical dots to open the action menu and click Remove User.
+
To edit a user, find the user to be edited and click the 3 vertical dots to open the action menu and click Edit User.
+
To add a user to a system, find the user to be added and click the 3 vertical dots to open the action menu and click Add to System. In the dialog, select the system to add the user to and click Save.
+
The service component will need some configuration items set in order to run successfully. These should be set in a file
+named config.yml. The following configuration items are available:
| Name | +Default | +Required | +Description | +
|---|---|---|---|
| database | +none | +yes | +Database connection information (See https://www.dropwizard.io/en/stable/manual/configuration.html#database) | +
| jwtCacheSpec | +expireAfterWrite=60m |
+yes | +Configuration for the JWT tokens being generated. Default expires after 60 minutes | +
| jwtCookieAuth | +none | +no | +JWT cookie configuration information (See https://github.com/dhatim/dropwizard-jwt-cookie-authentication#edit-you-apps-dropwizard-yaml-config-file) | +
| auditCleanup.initialDelay | +30s | +no | +Initial time to wait for cleanup job to start after server startup | +
| auditCleanup.intervalDelay | +1d | +no | +How often to run the cleanup job | +
| auditRecordsMaxRetain | +30d | +no | +How long audit records should be retained. | +
cd service
+mvn package --DskipTests
+java -jar target/champagne-service-<version>.jar db migrate config.yml
+java -jar target/champagne-service-<version>.jar server config.yml
+cd ui
+npm run dev
+Open your browser and go to http://localhost:5173
Champagne is a service that allows you to toast successful deployments. This service will assist a project in managing builds, +deployments, promotions to different environments and tracking manual deployment steps.
+ +' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..f4dec3c0 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Champagne Champagne is a service that allows you to toast successful deployments. This service will assist a project in managing builds, deployments, promotions to different environments and tracking manual deployment steps.","title":"Overview"},{"location":"#champagne","text":"Champagne is a service that allows you to toast successful deployments. This service will assist a project in managing builds, deployments, promotions to different environments and tracking manual deployment steps.","title":"Champagne"},{"location":"getting_started/","text":"Getting Started Prerequisites Postgres database (tested on 15.x) Java 17+ (if building/running from source) Node 18+ (if building/running from source) Configuration The service component will need some configuration items set in order to run successfully. These should be set in a file named config.yml . The following configuration items are available: Name Default Required Description database none yes Database connection information (See https://www.dropwizard.io/en/stable/manual/configuration.html#database) jwtCacheSpec expireAfterWrite=60m yes Configuration for the JWT tokens being generated. Default expires after 60 minutes jwtCookieAuth none no JWT cookie configuration information (See https://github.com/dhatim/dropwizard-jwt-cookie-authentication#edit-you-apps-dropwizard-yaml-config-file) auditCleanup.initialDelay 30s no Initial time to wait for cleanup job to start after server startup auditCleanup.intervalDelay 1d no How often to run the cleanup job auditRecordsMaxRetain 30d no How long audit records should be retained. Building and Running from Source Clone the repo from https://github.com/kiwiproject/champagne-service.git Service side Build the service: cd service mvn package --DskipTests Setup the database: java -jar target/champagne-service-The manage system page allows for changes to be made to various settings of the system.
+
Heads Up! This page can only be accessed by administrators of the deployable system!
+This section allows for the setting of which of the deployment environments should be marked as the first environment that components will be deployed to. Any environments after this environment will have builds promoted to that environment.
+This section allows the ordering of deployment environments in the system so that promotions will transition through the environments correctly.
+ +The system audits page lets a system admin user view audits of actions being taken by users in the system.
+
The tags page lets a system admin user manage a list of tags for the system that will be used to link hosts and components.
+
button at the bottom of the screenThe create new tag dialog will appear
+
Enter the new tag name (This is required)
+To delete a tag, find the row with the tag to be deleted and click the 3 vertical dots to open the action menu and select Remove.
+To edit a tag, find the row with the tag to be edited and click the 3 vertical dots to open the action menu and select Edit.
+ +The build page lets a user manage a list of builds available for deployment for the system.
+
TBD
+TBD
+TBD
+ +The component page lets a user manage a list of deployable components for the system.
+
Heads Up! Creating can only be performed by administrators of the deployable system!
+ button at the bottom of the screenThe create new component dialog will appear
+
Enter the new component name (This is required)
+Heads Up! Deleting can only be performed by administrators of the deployable system!
+To delete a component, find the row with the component to be deleted and click the 3 vertical dots to open the action menu and select Remove Component
+
Heads Up! Editing can only be performed by administrators of the deployable system!
+To edit a component, find the row with the component to be edited and click the 3 vertical dots to open the action menu and select Edit Component
+
The environments page lets a user manage a logical list of deployable environments for the overall system.
+
button at the bottom of the screenThe create new environment dialog will appear
+
Enter the new environment name (This is required)
+Deployable environments can be enabled and disabled. This might be a better option than deleting the environment if there +is historical data related to the environment that should be kept.
+Heads Up! Enabling and Disabling can only be performed by administrators of the deployable system!
+To disable an environment, find the row with the environment to be disabled, click the 3 vertical dots and select Deactivate.
+
To enable an environment, find the row with the environment to be enabled, click the 3 vertical dots and select Activate.
+
Deployable environments can be deleted. Beware, however, that this will also delete all information related to that +deployable environment
+Heads Up! Deleting can only be performed by administrators of the deployable system!
+To delete an environment, find the row with the environment to be deleted and click the 3 vertical dots and select Remove.
+
The host page lets a user manage a list of deployable hosts for the system.
+
Heads Up! Creating can only be performed by administrators of the deployable system!
+ button at the bottom of the screenThe create new host dialog will appear
+
Enter the new host name (This is required)
+Hosts can be deleted. This will only delete the host entry and will not delete any of the components linked to that host.
+Heads Up! Deleting can only be performed by administrators of the deployable system!
+To delete a host, find the row with the host to be deleted and click the 3 vertical dots to open the action menu and select Remove Host
+
Heads Up! Editing can only be performed by administrators of the deployable system!
+To edit a host, find the row with the host to be edited and click the 3 vertical dots to open the action menu and select Edit Host
+
The system users page lets a user manage a list of users in a system.
+
Heads Up! The following actions can only be performed by administrators of the deployable system!
+To remove a user from a system, find the user to be removed and click the 3 vertical dots to open the action menu and click Remove User.
+To make a user an admin in a system, find the row with the user to change and click the 3 vertical dots to open the action menu and click Become Admin.
+To remove the admin flag from a user in a system, find the row with the user to change and click the 3 vertical dots to open the action menu and click Remove Admin.
+ +The manual tasks page lets a user manage a list of releases and manual tasks that are needed in those releases for a system.
+
button at the bottom of the screenThe create new release dialog will appear
+
Enter the new release name (This is required)
+To delete a release, find the row with the release to be deleted and click the 3 vertical dots to open the action menu and select Delete Release. Note: This will delete all tasks in that release too.
+
The create new task dialog will appear
+
Enter the task summary (This is required)
+To delete a task, find the row with the task to be deleted and click the 3 vertical dots to open the action menu and select Delete Task.
+To change the status of a given task or release in a specific environment, click the icon showing the status. This will open the status change dialog. Choose the new status (Pending, Complete, Not Required) and click Save.
+ +