{"id":21306411,"url":"https://github.com/cf-toolsuite/home","last_synced_at":"2025-03-15T19:42:55.573Z","repository":{"id":226337843,"uuid":"768429693","full_name":"cf-toolsuite/home","owner":"cf-toolsuite","description":"The home for ideas and exploration. Mainly documentation, videos and discussion.","archived":false,"fork":false,"pushed_at":"2024-04-13T17:19:58.000Z","size":1427,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-04-14T08:00:26.676Z","etag":null,"topics":["documentation","how-to","installation-scripts","prerequisites","resources","sample-configuration"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cf-toolsuite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-07T04:12:35.000Z","updated_at":"2024-04-15T14:34:10.286Z","dependencies_parsed_at":"2024-03-07T04:34:29.663Z","dependency_job_id":"6d2611c4-7f20-4200-920c-febd4700f6a4","html_url":"https://github.com/cf-toolsuite/home","commit_stats":null,"previous_names":["cf-toolsuite/home"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cf-toolsuite%2Fhome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cf-toolsuite%2Fhome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cf-toolsuite%2Fhome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cf-toolsuite%2Fhome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cf-toolsuite","download_url":"https://codeload.github.com/cf-toolsuite/home/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243784100,"owners_count":20347409,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","how-to","installation-scripts","prerequisites","resources","sample-configuration"],"created_at":"2024-11-21T16:23:46.291Z","updated_at":"2025-03-15T19:42:55.554Z","avatar_url":"https://github.com/cf-toolsuite.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# home\n\nThe home for ideas and exploration.  Mainly documentation, videos and discussion.\n\n## Resources\n\n### Documentation\n\n* [Background](docs/Background%20on%20cf-toolsuite.pdf)\n* Evaluating\n  * [Locally](docs/Evaluating%20cf-toolsuite%20locally.pdf)\n  * [on Tanzu Application Service](docs/Evaluating%20cf-toolsuite%20on%20TAS.pdf)\n\n#### Community talks\n\n* [The Secret Lives of Java Apps: Stories Told at Runtime](docs/The%20Secret%20Lives%20of%20Java%20Apps%20Stories%20Told%20at%20Runtime.pdf)\n  * delivered @ [Seattle Java Users Group](https://www.seajug.org/) (May 21, 2024)\n\n### Pre-built artifacts\n\n* `.jar` files\n  * [cf-archivist](https://github.com/cf-toolsuite/cf-archivist/releases)\n  * [cf-butler](https://github.com/cf-toolsuite/cf-butler/releases)\n  * [cf-hoover](https://github.com/cf-toolsuite/cf-hoover/releases)\n  * [cf-hoover-ui](https://github.com/cf-toolsuite/cf-hoover-ui/releases)\n  * [spring-boot-starter-runtime-meta-data](https://central.sonatype.com/artifact/org.cftoolsuite.actuator/spring-boot-starter-runtime-metadata)\n\n* Container images on [Docker Hub](https://hub.docker.com/repositories/cftoolsuite)\n\n### Prerequisites\n\n#### Required\n\n* CF API endpoint and admin credentials to a Cloud Foundry foundation (e.g., Tanzu Application Service)\n\n##### Optional\n\n* Operations Manager admin credentials\n* VMware Tanzu Network API token\n\n#### Toolset\n\n* [gh](https://cli.github.com/)\n* [git](https://git-scm.com/downloads)\n* [cf](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html)\n* [docker](https://docs.docker.com/desktop/) (make sure you have the compose plugin)\n* [http](https://httpie.io/)\n* [jq](https://github.com/jqlang/jq)\n* [pack](https://github.com/buildpacks/pack)\n* [sdk](http://sdkman.io)\n\n### How to\n\n#### On Tanzu Application Service\n\nYou'll need to author two configuration files named `secrets.cf-butler.{foundation}.json` and `secrets.cf-archivist.{foundation}.json` and place them in the `/tmp/config` directory.  Crib from the samples in [footprints/tas/config](footprints/tas/config).\n\n* [Install](scripts/e2e-install.sh)\n* [Uninstall](scripts/e2e-uninstall.sh)\n* [Expose curated set of Spring Boot Actuator endpoints](scripts/expose-actuator-endpoints.sh)\n* Set Java artifacts [fetch mode](scripts/set-java-artifacts-fetch-mode.sh) on a [cf-butler](https://github.com/cf-toolsuite/cf-butler/blob/main/docs/ENDPOINTS.md#java-applications) instance\n* [Update Spring Cloud Config Server instance mirror](scripts/update-config-service-mirrors.sh) backing [cf-hoover](https://github.com/cf-toolsuite/cf-hoover?tab=readme-ov-file#minimum-required-keys) instance\n* [Switch](scripts/switch-backend-to-mysql.sh) backend to MySQL\n\n#### With Docker Compose\n\nYou'll need to author two configuration files named `butler.env` and `archivist.env` underneath [footprints/local/docker/config](footprints/local/docker/config).  Crib from the `*.sample` files.\n\n* [Build container images](scripts/build-container-images.sh)\n* [Startup](footprints/local/startup.sh)\n* [Shutdown](footprints/local/shutdown.sh)\n* [Show logs for a service](footprints/local/show-logs.sh)\n* [Status](footprints/local/status.sh)\n\n#### Work with available endpoints\n\nThis is not an exhaustive list.  Refer to respective service documentation for more details.\n\n* Trigger fresh collection on `cf-butler`\n  * on TAS: `http POST {cf-butler-route}/collect`\n  * w/ Docker Compose: `http POST :8080/collect`\n* Trigger cache refresh on `cf-hoover-ui`\n  * on TAS: `http POST {cf-hoover-ui-route}/cache/refresh`\n  * w/ Docker Compose: `http POST :8083/cache/refresh`\n* Trigger cache refresh on `cf-archivist`\n  * on TAS: `http POST {cf-archivist-route}/cache/refresh`\n  * w/ Docker Compose: `http POST :8081:/cache/refresh`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcf-toolsuite%2Fhome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcf-toolsuite%2Fhome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcf-toolsuite%2Fhome/lists"}