This pull request updates the README documentation for the Guardian PHP SDK, emphasizing the concept of "Configuration based Guardian policy consumption and management." The primary objective is to streamline the integration and usage of the SDK, making it more user-friendly and up-to-date with the latest Guardian API features.
Purpose
The updated README aims to simplify the setup process and clarify the usage of the SDK, bridging the gap between the middleware API and the current PHP SDK. This version builds on the foundation established by @jonwood2 and introduces enhancements to ensure compatibility with the latest Guardian API, facilitating a smoother production environment.
Objectives
Simplification: Revise and consolidate existing instructions to reduce complexity and focus on configuration-based management.
Integration: Ensure seamless interaction between the SDK and Guardian API, including potential future interfaces like Paladin.
Feedback Loop: Identify and suggest fixes for the Guardian API to enhance its reliability and production-readiness.
Installation and Running
Please note, this version is still under development and not recommended for production use. Detailed installation instructions are provided for those willing to experiment.
Current Issues
Ongoing challenges include inconsistent API responses, occasional Guardian lockups, and long-running tasks causing queue delays. These issues are being actively addressed to ensure a robust and reliable SDK.
Currently with Guardian we are facing some issues that I am working with the team to demo/duplicate, these are below are not complete/extensive.
Inconsistent API responses (Setting a role returns a Boolean instead of an object).
[x] Guardian occasionally (every Friday) locks up and there is complete data loss, the task queue gets full. Only way to stop it is to do doctor compose down, which locally destroys all data. (I have a theory this is related to the IPFS local node sync)
[x] long-running tasks can sometimes look up the task queue (this makes testing queries/commands inconsistent)
[x] Ability to send data via a tag, but inability to get block data via tag only through an id.
Overview
This pull request updates the README documentation for the Guardian PHP SDK, emphasizing the concept of "Configuration based Guardian policy consumption and management." The primary objective is to streamline the integration and usage of the SDK, making it more user-friendly and up-to-date with the latest Guardian API features. Purpose
The updated README aims to simplify the setup process and clarify the usage of the SDK, bridging the gap between the middleware API and the current PHP SDK. This version builds on the foundation established by @jonwood2 and introduces enhancements to ensure compatibility with the latest Guardian API, facilitating a smoother production environment.
Objectives
Installation and Running
Please note, this version is still under development and not recommended for production use. Detailed installation instructions are provided for those willing to experiment.
Current Issues
Ongoing challenges include inconsistent API responses, occasional Guardian lockups, and long-running tasks causing queue delays. These issues are being actively addressed to ensure a robust and reliable SDK.
Running Tests
Run the following command to execute tests:
Installation/Running (Don't do this)
If you are mental enough to run this in the next couple of weeks, you can follow the steps.
You can run the below line (and with a bit of luck, you should start hitting Guardian locally)
You need to rename this to be a policy file, and double check it doesn't keep the ZIP file ext.
mmcm_elv_production_publish_test.policy.zip
Current and ongoing issues
Currently with Guardian we are facing some issues that I am working with the team to demo/duplicate, these are below are not complete/extensive.