404
+ +Page not found
+ + +diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..77f5f1cb --- /dev/null +++ b/404.html @@ -0,0 +1,116 @@ + + +
+ + + + +Page not found
+ + +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..7f103b43 --- /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 environments page lets a user manage a logical list of deployable environments for the overall system.
+ +The 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 button.
+To enable an environment, find the row with the environment to be enabled, click the button.
+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 button.
+ +The host configuration page lets a user manage a list of deployable hosts and components for the system.
+ +Heads Up! Creating can only be performed by administrators of the deployable system!
+The 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 button.
+Heads Up! Creating can only be performed by administrators of the deployable system!
+The create new host dialog will appear
+ +Enter the new component name (This is required)
+Components can be deleted. This will delete the component entry and will unlink it from every host matching the tag.
+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 button.
+ +