Skip to content

Commit

Permalink
Remove the older docbook documentation and re-factor it into Markdown
Browse files Browse the repository at this point in the history
Instruction for deployment of HDS to a local K8S `kind` cluster
Simplication of the startup system for HDS
  • Loading branch information
andponlin committed Jun 7, 2024
1 parent 34850eb commit dc0d1dc
Show file tree
Hide file tree
Showing 99 changed files with 1,288 additions and 3,348 deletions.
4 changes: 4 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**/target
haikudepotserver-webapp/src/main/resources/local.properties
haikudepotserver-spa1/node
haikudepotserver-spa1/node_modules
33 changes: 15 additions & 18 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ COPY ./haikudepotserver-core-test/pom.xml /hds-src/haikudepotserver-core-test/po
COPY ./haikudepotserver-api1/pom.xml /hds-src/haikudepotserver-api1/pom.xml
COPY ./haikudepotserver-api2/pom.xml /hds-src/haikudepotserver-api2/pom.xml
COPY ./haikudepotserver-packagefile/pom.xml /hds-src/haikudepotserver-packagefile/pom.xml
COPY ./haikudepotserver-docs/pom.xml /hds-src/haikudepotserver-docs/pom.xml
COPY ./haikudepotserver-spa1/pom.xml /hds-src/haikudepotserver-spa1/pom.xml
COPY ./haikudepotserver-webapp/pom.xml /hds-src/haikudepotserver-webapp/pom.xml
COPY ./haikudepotserver-core/pom.xml /hds-src/haikudepotserver-core/pom.xml
Expand All @@ -66,7 +65,6 @@ COPY ./haikudepotserver-driversettings /hds-src/haikudepotserver-driversettings
COPY ./haikudepotserver-core-test /hds-src/haikudepotserver-core-test
COPY ./haikudepotserver-api2 /hds-src/haikudepotserver-api2
COPY ./haikudepotserver-packagefile /hds-src/haikudepotserver-packagefile
COPY ./haikudepotserver-docs /hds-src/haikudepotserver-docs
COPY ./haikudepotserver-webapp /hds-src/haikudepotserver-webapp
COPY ./haikudepotserver-spa1 /hds-src/haikudepotserver-spa1
COPY ./haikudepotserver-api1 /hds-src/haikudepotserver-api1
Expand All @@ -91,12 +89,8 @@ RUN apt-get update && \
ENV HDS_B_HTTP_PORT=8080
ENV HDS_B_HTTP_ACTUATOR_PORT=8081
ENV HDS_B_INSTALL_ROOT="/opt/haikudepotserver"
ENV HDS_B_PROPBIN="/opt/haikudepotserver/prop.sh"
RUN mkdir ${HDS_B_INSTALL_ROOT}

COPY ./support/deployment/prop.sh ${HDS_B_PROPBIN}
RUN chmod 755 ${HDS_B_PROPBIN}

COPY --from=build /hds-src/haikudepotserver-core/target/classes/build.properties ${HDS_B_INSTALL_ROOT}
COPY --from=build /hds-src/haikudepotserver-webapp/target/haikudepotserver-webapp-*.jar ${HDS_B_INSTALL_ROOT}/app.jar

Expand All @@ -105,18 +99,21 @@ ENV HDS_B_INSTALL_HVIF2PNG_PATH "${HDS_B_INSTALL_ROOT}/hvif2png-hrev57235/bin/hv

COPY ./support/deployment/config.properties ${HDS_B_INSTALL_ROOT}
ADD ./support/deployment/${HDS_B_HVIF2PNG_VERSION}.tgz ${HDS_B_INSTALL_ROOT}
COPY ./support/deployment/launch.sh ${HDS_B_INSTALL_ROOT}
RUN chmod 755 ${HDS_B_INSTALL_ROOT}/launch.sh

RUN echo "\
HDS_ROOT=${HDS_B_INSTALL_ROOT}\n\
JAVA_BIN=java\n\
HDS_HVIF2PNG_PATH=${HDS_B_INSTALL_HVIF2PNG_PATH}\n\
HDS_PORT=${HDS_B_HTTP_PORT}\n\
HDS_ACTUATOR_PORT=${HDS_B_HTTP_ACTUATOR_PORT}\n\
" >> ${HDS_B_INSTALL_ROOT}/launchenv.sh

CMD [ "/opt/haikudepotserver/launch.sh" ]

CMD \
java \
-Dfile.encoding=UTF-8 \
-Duser.timezone=GMT0 \
-Xms320m \
-Xmx512m \
-Djava.net.preferIPv4Stack=true \
-Djava.awt.headless=true \
-Dconfig.properties=file://${HDS_B_INSTALL_ROOT}/config.properties \
-Dhds.hvif2png.path=${HDS_B_INSTALL_HVIF2PNG_PATH} \
-Dserver.port=${HDS_B_HTTP_PORT} \
-Dmanagement.server.port=${HDS_B_HTTP_ACTUATOR_PORT} \
-jar \
${HDS_B_INSTALL_ROOT}/app.jar

HEALTHCHECK --interval=30s --timeout=10s CMD curl -f http://localhost:${HDS_B_HTTP_ACTUATOR_PORT}/actuator/health
EXPOSE ${HDS_B_HTTP_PORT} ${HDS_B_HTTP_ACTUATOR_PORT}
52 changes: 32 additions & 20 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,35 @@ This web application is an online tool for working with the software packages of
* A user interface to manipulate the _additional data_.
* A mechanism to vend this _additional data_ to HaikuDepot, a desktop application for managing packages.

## Deployments

| Environment | Modern Web | Simple Web |
| --- | --- | --- |
| Production | https://depot.haiku-os.org | https://depot.haiku-os.org/__multipage |

## Mailing List

A [mailing list](http://www.freelists.org/list/haiku-depot-web) exists to discuss and coordinate the project.

## Documentation and Development

Assuming the application server is deployed, you should be able to see relatively recent documentation
[here](http://depot.haiku-os.org/__docs/index.html).

## Other Helpful Resources

* [Haiku homepage](http://www.haiku-os.org)
* [HaikuPorts homepage](https://github.com/haikuports/haikuports/wiki) (for external packages)
* Haiku [package management documentation](https://github.com/haiku/haiku/blob/master/docs/develop/packages)
## Useful Links and resources

- [Haiku Depot Server web interface](https://depot.haiku-os.org)
- [Haiku Depot Server simplified web interface](https://depot.haiku-os.org/__multipage)
- [Haiku Depot Server Source code + issue tracking](https://github.com/haiku/haikudepotserver)
- [Haiku Depot Server mailing list](http://www.freelists.org/list/haiku-depot-web) to discuss and coordinate the project.
- [Haiku Depot Server license](LICENSE.TXT)
- [Haiku operating system project homepage](http://www.haiku-os.org)
- [HaikuPorts project homepage](https://github.com/haikuports/haikuports/wiki) (for external packages)
- [Haiku package management documentation](https://github.com/haiku/haiku/blob/master/docs/develop/packages)

## Documentation

### General System and Architecture

- [Overview](docs/overview.md)
- [Architecture](docs/architecture.md)
- [API](docs/api.md)
- [Security](docs/security.md)
- [Data Model](docs/data-model.md)
- [Integration](docs/integration.md)
- [Repositories](docs/repositories.md)
- [User Ratings](docs/user-rating.md)
- [Data Localization](docs/data-localization.md)
- [HDS Application Localization](docs/application-localization.md)

### Development and Deployment

- [hvif2png](docs/hvif2png.md)
- [Local Development](docs/local-development.md)
- [Kubernetes Development](docs/kubernetes-development.md)
- [Deployment](docs/deployment.md)
Loading

0 comments on commit dc0d1dc

Please sign in to comment.