Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

Add a detailed README and clean up the configuration file #94

Merged
merged 8 commits into from
Aug 18, 2022

Conversation

cmacknz
Copy link
Member

@cmacknz cmacknz commented Aug 15, 2022

Adds a detailed README file that includes an architecture diagram. Also cleans up the configuration file a little bit and documents all of the fields in the style of the Beats and Agent reference configurations.

It will be easiest to review the rendered README: https://github.com/cmacknz/elastic-agent-shipper/blob/add-readme/README.md

Closes #61

@cmacknz cmacknz added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Aug 15, 2022
@cmacknz cmacknz self-assigned this Aug 15, 2022
@cmacknz cmacknz requested a review from a team as a code owner August 15, 2022 15:50
@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 15, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-08-17T19:27:09.397+0000

  • Duration: 10 min 42 sec

Test stats 🧪

Test Results
Failed 0
Passed 40
Skipped 0
Total 40

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@cmacknz
Copy link
Member Author

cmacknz commented Aug 15, 2022

The test failures are all the same. The fix is one one of @rdner's branches:

 === RUN   TestPublish/should_return_validation_errors/no_timestamp
    server_test.go:243: 
        	Error Trace:	server_test.go:243
        	Error:      	Not equal: 
        	            	expected: "timestamp: proto:\u00a0invalid nil Timestamp"
        	            	actual  : "timestamp: proto: invalid nil Timestamp"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -1 +1 @@
        	            	-timestamp: proto: invalid nil Timestamp
        	            	+timestamp: proto: invalid nil Timestamp
        	Test:       	TestPublish/should_return_validation_errors/no_timestamp
        --- FAIL: TestPublish/should_return_validation_errors/no_timestamp (0.00s)

- Include design goals and architecture details.
- Include a section on client development.
- Include contributing and development sections.
- Document all fields in the config file.
- Move some general parameters under the server object.
.github/ISSUE_TEMPLATE/bug-report.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/question.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
elastic-agent-shipper.yml Outdated Show resolved Hide resolved
queue/config.go Show resolved Hide resolved
@cmacknz cmacknz merged commit 5df6b78 into elastic:main Aug 18, 2022
@cmacknz cmacknz deleted the add-readme branch August 18, 2022 14:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add initial repository documentation
4 participants